Error Handling

When a problem occurs in Launch, an error may be returned in one of the following ways:

API response

When performing an API request that results in an immediate error, an error response will be returned by the API, with the HTTP code reflecting the general type of error that occured.

Resource `meta`

When performing an API request that results in a delayed error, an asynchronous activity for example, an error may be returned by the API in the {"meta": {"status_details": ... }} of a related resource.

Error Format

Error responses aim to conform to the JSONAPI Errors specification, and will generally adhere to the following structure:

id: a unique identifier for this particular occurrence of the problem.
status: the HTTP status code applicable to this problem, expressed as a string value.
code: an application-specific error code, expressed as a string value.
title: a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail: a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
source: an object containing references to the source of the error, optionally including any of the following members:
- pointer: a JSON Pointer [RFC6901] to the associated entity in the request document [e.g. “/data” for a primary data object, or “/data/attributes/title” for a specific attribute].
meta: a meta object containing non-standard meta-information about the error.

For example:

{
  "errors": [
    {
      "id": "8a5526da-ab12-4be9-b084-2efe537f388c",
      "status": "404",
      "code": "not-found",
      "title": "Record Not Found",
      "meta": {
        "request_id": "jfb0dQ2e0XVTkQ6AOfEJFfTDjguw9x3d"
      },
      "source": {
      }
    }
  ]
}

Errors

`authentication-failure`

Your IMS access token is invalid. You can get a new access token by signing in again. Or for technical accounts, generating a new JWT and swapping for an IMS access token.

`cannot-be-changed`

The resource cannot be changed.

`connection-refused`

A connection to the server could not be established.

`core-extension-update-required`

Required update to Core Extension

`decrypt-bad-passphrase`

The data could not be decrypted with the provided passphrase.

`decrypt-failed`

The data could not be decrypted with the provided private key. Ensure the key works locally and that whitespace has been trimmed.

`decrypt-no-data`

The data cannot be decrypted without a private key. Please provide an encryped private key.

`delegate-descriptor-unresolved`

The extension did not provide the expected definition of this delegate descriptor. The extension may need to be updated.

`deleted-resources`

The resources that you are trying to add to your Library have been deleted.

`environment-in-use`

An Environment can only be assigned to one Library at a time. Option 1 is to choose a different environment. Option 2 is to free up this Environment by moving the Library to another Environment or deleting the Library.

`environment-required`

Your Library must have an Environment assigned before you can create a Build.

`extension-not-found`

The extension that defines a data element or rule component is not included in the library. Ensure that all the required extensions have been added to your library.

`extension-package-path-error`

A path defined in extension.json was incorrectly constructed.

`extension-package-transform-definition-error`

You have defined an invalid transform for an object property. Each object property can have one transform defined and it must be a file transform or a function transform.

`extension-package-zip-error`

An error occurred while unzipping the ExtensionPackage or zipping the files for distribution.

`host-in-use`

A Host may not be deleted if one or more Environments are using it.

`host-required`

The Environment assigned to this Library does not have a valid Host. Check which Environment is assigned to your Library. Then assign a valid Host to that Environment.

`host-type-error`

Only SFTP Hosts need to have credentials verified before they can be used, so the pretest is only available for that Host type.

`id-mismatch`

The id in the payload has to match the id in the path

`illegal-custom-code-transform`

You are not allowed to use the customCode transform. Please specify a function or file transform.

`ims-not-authorized`

An unknown error occurred authorizing your account. Please try again later.

`ims-session-error`

There is an issue with the signed-in session. Please log out and log in again.

`internal-error`

An internal error occurred. Please wait a few minutes and try again. If the issue persists, please contact Client Care.

`invalid-data_element`

An invalid data element cannot be added to a library.

`invalid-extension`

An invalid extension cannot be added to a library.

`invalid-extension_package_id`

You can only modify some of the object properties of an Extension Package. You tried to modify one of the ones that is not allowed.

`invalid-new-owner-org-id`

The Org ID you tried to assign is not a valid Org ID.

`invalid-org`

Your active Org doesn't have Launch access. Check that you're using the correct Org.

`invalid-property`

A secret can only be added to an edge property.

`invalid-rule`

An invalid rule cannot be added to a library.

`invalid-settings-syntax`

A syntax error was encountered while parsing the settings JSON.

`library-file-not-found`

A required file defined in extension.json could not be found inside the zip package.

`minification-error`

The code could not be compiled due to invalid code or ES6 code.

`multiple-revisions`

Only one revision of each resource can be included in a library.

`no-available-orgs`

This user account does not belong to a product profile that has access to Launch. Use the Admin Console to add this user to a product profile with Launch rights.

`not-authorized`

This user account does not have the necessary permissions to perform this action.

`not-found`

The record could not be found. Verify the id of the object that you're trying to retrieve.

`not-unique`

The name you are trying to use is already in use. For this resource, the 'name' property must be unique.

`provisioning-error`

An unexpected error occurred. You should contact Customer Care to complete provisioning.

`public-release-not-authorized`

Public release of extensions is coordinated by launch-ext-dev@adobe.com.

`read-only`

This resource is read-only and cannot be modified.

`secret-authorization-error`

An unknown error occurred while processing the secret. Please try again later or contact Customer Care.

`secret-bytesize-error`

The exchanged secret has a bytesize higher than the allowed 5120 bytes.

`secret-connection-refused-error`

The connection to the provided token_url was refused. Please check your credentials or try again later.

`secret-forbidden-error`

The token_url responded with 403. This usually means that token_url is not correct.

`secret-invalid-domain-error`

The provided token_url domain cannot be resolved and it is considered invalid.

`secret-invalid-response-error`

The token_url is expected to respond with 2xx. If this is not happening, the response is considered invalid.

`secret-not-found-error`

The token_url responded with 404. This usually means that token_url is not correct.

`secret-processing-error`

An unknown error occurred while processing the secret. Please try again later or contact Customer Care.

`secret-propagation-error`

An unexpected error occurred. You can try again later or give Customer Care a call and explain what you were doing when it happened.

`secret-propagation-validation-error`

The secret propagation could not be validated within the 2 minutes threshold.

`secret-refresh-error`

`secret-refresh-request-error`

`secret-timeout-error`

The request to the provided token_url times out after 60s.

`secret-unauthorized-error`

The token_url responded with 401. This usually means that the client_id and client_secret failed to be authorized.

`server-side-deployment-error`

An unexpected error occurred. You can try again later or give Customer Care a call and explain what you were doing when it happened.

`session-timeout`

The user session has expired. Please log out and log in again.

`sftp-authentication-failed`

Authentication failed for the SFTP connection.

`sftp-connection-timeout`

The SFTP connection has timed out.

`sftp-exception`

An exception was encountered when using SFTP to connect to the server.

`sftp-status-exception`

An SFTP exception was encountered while trying to communicate with the server.

`socket-error`

A socket error was encountered while trying to communicate with the server.

`ssh-disconnect`

The SSH session was disconnected.

`timeout-error`

The connection with the server timed out.

`unknown-error`

An unexpected error occurred. You can try again later or give Customer Care a call and explain what you were doing when it happened.

`unsupported-custom-code-language`

A custom code language was supplied that is not supported.

`unsupported-ecma-version`

The library modules contain code written in an ECMAScript version that is not supported.

`upgraded-extension-required`

Once you've installed an extension upgrade, you must include it in all Libraries until the upgrade gets to Production. The only exception is if the extension has not been published yet.

`upstream-build-required`

A successful Build for the upstream Library is required before you can build this one.

Error Handling

API response

Resource meta

Error Format

Errors

authentication-failure

cannot-be-changed

connection-refused

core-extension-update-required

decrypt-bad-passphrase

decrypt-failed

decrypt-no-data

delegate-descriptor-unresolved

deleted-resources

environment-in-use

environment-required

extension-not-found

extension-package-path-error

extension-package-transform-definition-error

extension-package-zip-error

host-in-use

host-required

host-type-error

id-mismatch

illegal-custom-code-transform

ims-not-authorized

ims-session-error

internal-error

invalid-data_element

invalid-extension

invalid-extension_package_id

invalid-new-owner-org-id

invalid-org

invalid-property

invalid-rule

invalid-settings-syntax

library-file-not-found

minification-error

multiple-revisions

no-available-orgs

not-authorized

not-found

not-unique

provisioning-error

public-release-not-authorized

read-only

secret-authorization-error

secret-bytesize-error

secret-connection-refused-error

secret-forbidden-error

secret-invalid-domain-error

secret-invalid-response-error

secret-not-found-error

secret-processing-error

secret-propagation-error

secret-propagation-validation-error

secret-refresh-error

secret-refresh-request-error

secret-timeout-error

secret-unauthorized-error

server-side-deployment-error

session-timeout

sftp-authentication-failed

sftp-connection-timeout

sftp-exception

sftp-status-exception

socket-error

ssh-disconnect

timeout-error

unknown-error

unsupported-custom-code-language

unsupported-ecma-version

upgraded-extension-required

upstream-build-required

Resource `meta`

`authentication-failure`

`cannot-be-changed`

`connection-refused`

`core-extension-update-required`

`decrypt-bad-passphrase`

`decrypt-failed`

`decrypt-no-data`

`delegate-descriptor-unresolved`

`deleted-resources`

`environment-in-use`

`environment-required`

`extension-not-found`

`extension-package-path-error`

`extension-package-transform-definition-error`

`extension-package-zip-error`

`host-in-use`

`host-required`

`host-type-error`

`id-mismatch`

`illegal-custom-code-transform`

`ims-not-authorized`

`ims-session-error`

`internal-error`

`invalid-data_element`

`invalid-extension`

`invalid-extension_package_id`

`invalid-new-owner-org-id`

`invalid-org`

`invalid-property`

`invalid-rule`

`invalid-settings-syntax`

`library-file-not-found`

`minification-error`

`multiple-revisions`

`no-available-orgs`

`not-authorized`

`not-found`

`not-unique`

`provisioning-error`

`public-release-not-authorized`

`read-only`

`secret-authorization-error`

`secret-bytesize-error`

`secret-connection-refused-error`

`secret-forbidden-error`

`secret-invalid-domain-error`

`secret-invalid-response-error`

`secret-not-found-error`

`secret-processing-error`

`secret-propagation-error`

`secret-propagation-validation-error`

`secret-refresh-error`

`secret-refresh-request-error`

`secret-timeout-error`

`secret-unauthorized-error`

`server-side-deployment-error`

`session-timeout`

`sftp-authentication-failed`

`sftp-connection-timeout`

`sftp-exception`

`sftp-status-exception`

`socket-error`

`ssh-disconnect`

`timeout-error`

`unknown-error`

`unsupported-custom-code-language`

`unsupported-ecma-version`

`upgraded-extension-required`

`upstream-build-required`