Understand how the Application Lifecycle Management (ALM) API works, its behaviors, and what you should consider when building integrations.

The ALM API enables external applications, scripts, and integration tools to connect securely with Anaplan models and carry out ALM model operations.

This page describes expected behaviors and design considerations when creating an API integration.

The ALM API has predefined behaviors and processes based on the type of ALM requests that are carried out. ALM operations require that a number of conditions be met before beginning:

Ensure that your network infrastructure allows traffic to and from Anaplan API services. For complete firewall and IP allowlist specifications, refer to URL, IP, and allowlist requirements.

Unless otherwise specified, calls to the ALM API require Workspace Administrator permissions on both the source and target model workspaces.

Anaplan ALM API endpoints require a JSON Web Token (JWT) provided in the request headers.

All API calls must include a valid Anaplan authentication token. This is included in a request header in the following format: Authorization: AnaplanAuthToken {anaplan_auth_token}

Note: Replace {anaplan_auth_token} with your active token. Read more about retrieving this token in the Authentication API documentation.

If your workspace utilizes Single Sign-On (SSO), users making basic authentication API calls must be designated as an Exception User to successfully obtain a token. Refer to Assign Exception Users in Anapedia.

If using CA certificates to authenticate, the ALM API can't be called under either of these configurations:

  • The user is a non-exception user in the Development Model, but an exception user in the Production Model.
  • The user is a non-exception user in both the Development and Production Models.