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 6.0 now supports use of API Tokens, See API Tokens for details.
Version 2 API Details
Version 2 APIs use Basic Authentication. It supports token-based authentication.
V2 documentation is hosted at https://flexagon.com/api-spec/6.0
GraphQL API Details
The GraphQL schema is server from the FlexDeploy server. One easy way to call it is to use Postman.
POST to http(s)://{{FLEXDEPLOY_SERVER_HOSTNAME}}:{{FLEXDEPLOY_SERVER_PORT}}/flexdeploy/rest/v2/graphql
Fill in the Authorization information
Postman will automatically fetch the schema and help autocomplete your requests.
Other tools like GraphiQL would also work, just point them at the same URL and provide authorization information.
Version 1 API Details
Version 1 APIs use Basic Authentication, but not tokens.
V1 will be removed in the future, but V2 doesn’t contain all of V1 functionality yet.
Project | ||
|---|---|---|
Project Execution | ||
Workflow | ||
Topology | ||
Tasks | ||
Release | ||
Create new snapshot, promote existing project version to create new snapshot. | ||
Security | ||
Administration | ||