FlexDeploy API Guide

This API Guide provides detailed instructions for using the APIs included with FlexDeploy. See the FlexDeploy Installation Guide for information related to installation. See also the FlexDeploy Plugin Guides for detailed instructions for configuring and using the FlexDeploy plugins.

FlexDeploy supports the use of API Tokens for REST calls, See https://flexagon.atlassian.net/wiki/spaces/FD65/pages/10125816322 for details.

Version 2 API Details

Version 2 APIs use Basic Authentication. It supports username/password or token-based authentication.

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

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.

Version 1 API Details

Version 1 APIs supports username/password or token-based authentication.

V1 APIs will be removed in the future versions of FlexDeploy.

The following macros are not currently supported in the footer:
  • style