Adobe Launch Extension Packages API

openapi: 3.2.0
info:
  title: Adobe Launch Extension Packages API
  version: '1.0'
  description: 'Operations tagged Extension Packages across 2 of this provider''s published API definitions: adobe-launch-extension-packages-api-openapi.yml, adobe-launch-reactor-api-published-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://reactor.adobe.io
  description: Adobe Reactor API production gateway
- url: //reactor.adobe.io
tags:
- name: Extension Packages
  description: Manage extension packages that define capabilities, library modules, and views available to Adobe Experience Platform Tags users.
paths:
  /extension_packages:
    servers:
    - url: https://reactor.adobe.io
      description: Adobe Reactor API production gateway
    get:
      operationId: listExtensionPackages
      summary: List Extension Packages
      description: Retrieve all extension packages you have access to, with optional filtering by archive status, name, stage, and date fields.
      tags:
      - Extension Packages
      parameters:
      - name: filter[name]
        in: query
        schema:
          type: string
        description: Filter by extension package name.
        example: example_value
      - name: filter[platform]
        in: query
        schema:
          type: string
          enum:
          - web
          - mobile
          - edge
        description: Filter by platform type.
        example: web
      - name: filter[availability]
        in: query
        schema:
          type: string
          enum:
          - development
          - private
          - public
        description: Filter by availability status.
        example: development
      - name: filter[created_at]
        in: query
        schema:
          type: string
        description: Filter by creation date.
        example: example_value
      - name: filter[updated_at]
        in: query
        schema:
          type: string
        description: Filter by last updated date.
        example: example_value
      - name: page[number]
        in: query
        schema:
          type: integer
          minimum: 1
        description: Page number for pagination.
        example: 10
      - name: page[size]
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 100
        description: Number of results per page.
        example: 10
      responses:
        '200':
          description: A list of extension packages.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ExtensionPackageListResponse'
              examples:
                Listextensionpackages200Example:
                  summary: Default listExtensionPackages 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: extension_packages
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createExtensionPackage
      summary: Create an Extension Package
      description: Upload a new extension package as a ZIP file using multipart form data. The package must include a valid extension.json manifest.
      tags:
      - Extension Packages
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - package
              properties:
                package:
                  type: string
                  format: binary
                  description: The extension package ZIP file containing the extension.json manifest, library modules, and views.
            examples:
              CreateextensionpackageRequestExample:
                summary: Default createExtensionPackage request
                x-microcks-default: true
                value:
                  package: example_value
      responses:
        '201':
          description: Extension package created successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ExtensionPackageSingleResponse'
              examples:
                Createextensionpackage201Example:
                  summary: Default createExtensionPackage 201 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: extension_packages
                      relationships: {}
                      links:
                        self: https://www.example.com
        '400':
          $ref: '#/components/responses/BadRequest'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /extension_packages/{extensionPackageId}:
    servers:
    - url: https://reactor.adobe.io
      description: Adobe Reactor API production gateway
    get:
      operationId: getExtensionPackage
      summary: Retrieve an Extension Package
      description: Look up a specific extension package by its ID.
      tags:
      - Extension Packages
      parameters:
      - $ref: '#/components/parameters/extensionPackageId'
      responses:
        '200':
          description: Extension package details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ExtensionPackageSingleResponse'
              examples:
                Getextensionpackage200Example:
                  summary: Default getExtensionPackage 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: extension_packages
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateExtensionPackage
      summary: Update an Extension Package
      description: Update an existing extension package by uploading a new ZIP file. Can also be used to release privately (meta.action = release_private) or discontinue a package (setting discontinued = true).
      tags:
      - Extension Packages
      parameters:
      - $ref: '#/components/parameters/extensionPackageId'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                package:
                  type: string
                  format: binary
                  description: The updated extension package ZIP file.
            examples:
              UpdateextensionpackageRequestExample:
                summary: Default updateExtensionPackage request
                x-microcks-default: true
                value:
                  package: example_value
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ExtensionPackageUpdateRequest'
            examples:
              UpdateextensionpackageRequestExample:
                summary: Default updateExtensionPackage request
                x-microcks-default: true
                value:
                  data:
                    id: abc123
                    type: extension_packages
                    attributes:
                      discontinued: true
                    meta:
                      action: release_private
      responses:
        '200':
          description: Extension package updated successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ExtensionPackageSingleResponse'
              examples:
                Updateextensionpackage200Example:
                  summary: Default updateExtensionPackage 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: extension_packages
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /extension_packages/{extensionPackageId}/versions:
    servers:
    - url: https://reactor.adobe.io
      description: Adobe Reactor API production gateway
    get:
      operationId: listVersionsForExtensionPackage
      summary: List Versions for an Extension Package
      description: Retrieve all previous versions of an extension package.
      tags:
      - Extension Packages
      parameters:
      - $ref: '#/components/parameters/extensionPackageId'
      - name: page[number]
        in: query
        schema:
          type: integer
          minimum: 1
        example: 10
      - name: page[size]
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 100
        example: 10
      responses:
        '200':
          description: A list of extension package versions.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ExtensionPackageListResponse'
              examples:
                Listversionsforextensionpackage200Example:
                  summary: Default listVersionsForExtensionPackage 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: extension_packages
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /extension_packages/{EXTENSION_PACKAGE_ID}:
    servers:
    - url: //reactor.adobe.io
    get:
      tags:
      - Extension Packages
      summary: Retrieve an extension package
      description: '>**NOTE**: For more information on using this operation, see the [extension packages endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extension-packages.html) on Experience League.'
      operationId: retrieveExtensionPackage
      parameters:
      - name: EXTENSION_PACKAGE_ID
        in: path
        description: The ID of the extension package you want to look up.
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
        required: true
        schema:
          type: string
      - name: Accept
        in: header
        description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
        required: true
        schema:
          type: string
      responses:
        '200':
          x-summary: Success
          description: A successful response returns the details of the extension package.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/extensionPackagesLookupResponse'
    post:
      tags:
      - Extension Packages
      summary: Update an extension package
      description: 'Only development extension packages can be updated using a new archive file. Once the extension package has been transitioned to either private or public, it can no longer be updated. If you want to add new functionality or fix bugs, you must first create a new extension package with the same name, but with a new version. When this new extension package is transitioned to private or public, it will become available in the marketplace and replace the previous version.


        >**NOTE**: For more information on using this operation, see the [extension packages endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extension-packages.html) on Experience League.'
      operationId: updateExtensionPackage
      parameters:
      - name: EXTENSION_PACKAGE_ID
        in: path
        description: The ID of the development extension package you want to update.
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: This header must be provided with a value of `multipart/form-data` for all requests that require archive file uploads.
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
              - package
              type: object
              properties:
                package:
                  type: string
                  description: The extension package archive file.
                  format: binary
        required: true
      responses:
        '200':
          x-summary: Success
          description: A successful response returns the details of the updated extension package.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/extensionPackagesLookupResponse'
    patch:
      tags:
      - Extension Packages
      summary: Privately release or discontinue an extension package
      description: "Once you have completed testing your extension package you can release it privately. This makes it available to any property within your company. After you have released it privately, you can begin the public release process by filling out the [Public Release Request Form](https://adobe.allegiancetech.com/cgi-bin/qwebcorporate.dll?idx=7DRB5U).\n  \n\nWhen privately releasing or discontinuing an extension package, its ID must be provided in both the request path and the request payload. These IDs must match in order for the call to be successful.\n\n\n>**NOTE**: For more information on using this operation, see the [extension packages endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extension-packages.html) on Experience League."
      operationId: privateReleaseExtensionPackage
      parameters:
      - name: EXTENSION_PACKAGE_ID
        in: path
        description: The ID of the development extension package you want to privately release or discontinue.
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/extensionPackagesPatchPayload'
        required: true
      responses:
        '200':
          x-summary: Success
          description: A successful response returns the details of the updated extension package.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/extensionPackagesPatchResponse'
      x-codegen-request-body-name: body
  /extension_packages/{EXTENSION_PACKAGE_ID}/versions:
    servers:
    - url: //reactor.adobe.io
    get:
      tags:
      - Extension Packages
      summary: Retrieve an extension package's versions
      description: '>**NOTE**: For more information on using this operation, see the [extension packages endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extension-packages.html) on Experience League.'
      operationId: retrieveExtensionPackageVersion
      parameters:
      - name: EXTENSION_PACKAGE_ID
        in: path
        description: The ID of the extension package whose versions you want to retrieve.
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
        required: true
        schema:
          type: string
      - name: Accept
        in: header
        description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
        required: true
        schema:
          type: string
      responses:
        '200':
          x-summary: Success
          description: A successful response returns a list of each version of the extension package.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/extensionPackagesVersionsListResponse'
components:
  schemas:
    extensionPackagesLookupResponse:
      allOf:
      - $ref: '#/components/schemas/dataLookup'
      - type: object
        properties:
          data:
            type: object
            allOf:
            - $ref: '#/components/schemas/extensionPackagesEntity'
    Relationship:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
            type:
              type: string
          example: example_value
        links:
          type: object
          properties:
            related:
              type: string
              format: uri
          example: example_value
    extensionPackagesPatchPayload:
      allOf:
      - $ref: '#/components/schemas/dataUpdateExtensionPackage'
    extensionPackagesEntity:
      allOf:
      - $ref: '#/components/schemas/basicResourceProperties'
      - type: object
        properties:
          attributes:
            type: object
            properties:
              actions:
                type: array
                description: Lists the details of the action types defined by the extension.
                items:
                  $ref: '#/components/schemas/actionEntity'
              author:
                type: object
                properties:
                  url:
                    type: string
                    description: The URL for the author's website.
                  name:
                    type: string
                    description: The author's name.
                  email:
                    type: string
                    description: The author's email.
                description: Lists the details of the extension package author.
              availability:
                type: string
                description: The availability of the extension package, either `public`  or `private`.
              cdn_path:
                type: string
                description: The content delivery path for the extension package.
              conditions:
                type: array
                description: Lists the details of the condition types defined by the extension.
                items:
                  $ref: '#/components/schemas/conditionEntity'
              configuration:
                type: object
                properties:
                  id:
                    type: string
                    description: The [delegate descriptor ID](https://experienceleague.adobe.com/docs/experience-platform/tags/api/guides/delegate-descriptor-ids.html) for the configuration.
                  schema:
                    type: object
                    properties: {}
                    description: A [JSON Schema](https://json-schema.org/) object that describes the configuration properties for the extension.
                  viewPath:
                    type: string
                    description: The relative URL to the extension configuration view. It should be relative to `viewBasePath` and should not begin with a slash. It must reference an HTML file with a `.html` extension. Query string and fragment identifier (hash) suffixes are acceptable.
                  transforms:
                    type: array
                    description: An optional array of objects where each object represents a transformation that should be performed on every corresponding settings object when it is emitted into the runtime library. Refer to the documentation section on [transforms](https://experienceleague.adobe.com/docs/experience-platform/tags/extension-dev/manifest.html?lang=en#transforms) for more information on how to use this field.
                    items:
                      type: object
                      properties: {}
                description: Describes the configuration options for the extension.
              created_at:
                type: string
                description: A timestamp of when the extension configuration was created.
              data_elements:
                type: array
                description: Lists the details of the data element types defined by the extension.
                items:
                  $ref: '#/components/schemas/dataElementEntity'
              description:
                type: string
                description: A description for the extension.
              discontinued:
                type: boolean
                description: Indicated whether the extension is discontinued.
              display_name:
                type: string
                description: A display name for the extension.
              events:
                type: array
                description: Lists the details of the event types defined by the extension.
                items:
                  $ref: '#/components/schemas/eventEntity'
              exchange_url:
                type: string
                description: The Adobe Exchange URL for the extension.
              hosted_lib_files:
                type: array
                description: 'Some extension developers prefer hosting all tags-related files on their own server. This provides an increased level of certainty regarding file availability at runtime and allows you to easily scan the code for security vulnerabilities. If the library portion of your extension needs to load JavaScript files at runtime, it is recommended you use this property to list those files. The listed files will be hosted alongside the tag runtime library. Your extension can then load the files via a URL retrieved using the [getHostedLibFileUrl](https://experienceleague.adobe.com/docs/experience-platform/tags/extension-dev/turbine.html?lang=en#get-hosted-lib-file) method.



                  This property provides a list of relative paths to third-party library files that need to be hosted.'
                items:
                  type: string
              icon_path:
                type: string
                description: The path to the image that is used as the extension's icon in the Data Collection UI.
              main:
                type: string
                description: 'The relative path of a library module that should be executed at runtime.



                  This module will always be included in the runtime library and executed. Because the module is always included in the runtime library, a `main` module should only be used when absolutely necessary and its code size should be kept minimal.'
              name:
                type: string
                description: The name of the extension. It must be unique from all  other extensions and must comply with [naming rules](https://experienceleague.adobe.com/docs/experience-platform/tags/extension-dev/manifest.html?lang=en#naming-rules).  This is used by the system as an identifier and should not be  changed after the extension is published.
              owner_org_id:
                type: string
                description: The ID of the IMS Organization that owns the extension.
              resources:
                type: array
                description: A list of relative paths to verious asset files that  are used by the extension view, such as HTML and CSS files.
                items:
                  type: string
              shared_modules:
                type: array
                description: An list of shared module definition objects.
                items:
                  type: object
                  properties:
                    name:
                      type: string
                      description: The name of the shared module. Note that this name will be used when referencing shared modules from other extensions as described in the [documentation](https://experienceleague.adobe.com/docs/experience-platform/tags/extension-dev/web/shared.html?lang=en). This name is never displayed in any user interface. It should be unique from the names of other shared modules within your extension and must comply with [naming rules](https://experienceleague.adobe.com/docs/experience-platform/tags/extension-dev/manifest.html?lang=en#naming-rules). This is used by the system as an identifier and should not be changed after you publish your extension.
                    libPath:
                      type: string
                      description: The relative path to the shared module. It should not begin with a slash and must reference a JavaScript file with a `.js` extension.
              status:
                type: string
                description: The current status of the extension package.
              platform:
                type: string
                description: The platform for your extension. Currently the only value accepted is `web`.
              updated_at:
                type: string
                description: A timestamp of when the extension package was last updated.
              version:
                type: string
                description: The version number of the extension package.
              view_base_path:
                type: string
                description: The relative path to the subdirectory containing all  views and view-related resources (HTML, JavaScript, CSS, images)  for the extension. Platform hosts this directory on a web server  and loads `iframe` content from it. This is a required field and  should not start with a slash. For example, if all views are contained  within `src/view/`, the value of viewBasePath would be `src/view/`.
            description: Contains the extension package's attributes.
          links:
            type: object
            properties:
              self:
                type: string
                description: A link to the extension package itself.
            description: Contains links related to the extension package which can be used in subsequent fetch requests.
          meta:
            type: object
            properties:
              archive_url:
                type: string
                description: The archive URL for the extension package.
              script_sources:
                type: array
                description: Lists references for any script sources associated with the extension package.
                items:
                  type: string
            description: Contains meta information about the extension package.
    extensionPackagesPatchResponse:
      allOf:
      - $ref: '#/components/schemas/extensionPackagesLookupResponse'
    ExtensionPackageListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ExtensionPackageResource'
          example: []
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    metaList:
      type: object
      properties:
        meta:
          type: object
          properties:
            pagination:
              type: object
              properties:
                current_page:
                  type: integer
                  description: The current page of the response.
                next_page:
                  type: integer
                  description: The next page of 

# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-launch/refs/heads/main/openapi/adobe-launch-extension-packages-api-openapi.yml