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 APIs use Basic Authentication. It supports username/password or token-based authentication.
V2 documentation is hosted at https://flexagon.com/api-spec/6.0
The GraphQL schema is served on the FlexDeploy server. It can easily be retrieved using Postman, GraphiQL, or similar tools.
Start a POST request to http(s)://{{FLEXDEPLOY_SERVER_HOSTNAME}}:{{FLEXDEPLOY_SERVER_PORT}}/flexdeploy/rest/v2/graphql
Fill in the Authorization information. Basic authentication is supported with username/password or a token.
Some tools will automatically fetch the schema and help autocomplete your requests when you start filling in the request body. Otherwise, you can run an introspection query to get schema 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 | ||