FlexDeploy API Guide

Owned by Karl Henselin
Last updated: Nov 17, 2023 by Chandresh Patel
1 min read

This API Guide provides detailed instructions for using the APIs included with FlexDeploy.

FlexDeploy REST APIs use Basic Authentication. They support username/password or token-based authentication. See API Tokens for details. FlexDeploy 7.0 REST APIs support API Tokens for all types of users - internal and external.

Version 2 API Details

V2 documentation is hosted at https://flexagon.com/api-spec/7.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/7.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.

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