Skip to main content
This API Guide provides detailed instructions for using the APIs included with FlexDeploy. FlexDeploy REST APIs use Basic Authentication and support both username/password and token-based authentication. API Tokens are supported for all user types in the Local and External realms. Any groups assigned on the Edit User page are stored in the Local realm and are always considered for user authorization in both REST API and UI access. When Realm-level Group Mapping is allowed with REST API, these locally assigned groups are added to (rather than replacing) the groups provided by the Realm. Users in the Local realm and External (LDAP, non-SSO) realm can access REST APIs using either username/password or token. Users in the SSO realm can access REST APIs only using a token. Because SSO-based group mappings are not applied to REST API calls, authorization is determined solely by the groups mapped locally on the Edit User page. If Realm-level Group Mapping is enabled for SSO, this means that any user who requires REST API access must have the same groups replicated locally—an approach that works but is not ideal, as it creates additional administrative overhead and increases the risk of authorization inconsistencies between UI and API access. See API Tokens for details on tokens.

​
Version 2 API Details

V2 documentation is hosted at https://flexagon.com/api-spec/9.0/v2

​
Version 1 API Details

All V1 REST APIs have been deprecated since FlexDeploy 6.0. These APIs are still available but some may be removed in the next major FlexDeploy release. The exact APIs scheduled for removal in next major release will be declared in upcoming monthly releases.
  • Application API (/flexdeploy/rest/v1/application) was previously removed from V1. Application concept was removed in FlexDeploy 6.0
V1 documentation is hosted at https://flexagon.com/api-spec/9.0/v1

​
GraphQL API Details

The GraphQL schema is served on the FlexDeploy server. It can easily be retrieved using Postman, GraphQL, or similar tools. See GraphQL API Queries for more information about using FlexDeploy GraphQL queries.