Skip to main content
Version: Release SaaS

Digital.ai Release SaaS Developer Docs

Digital.ai Release SaaS provides a REST API that lets you interact with the platform outside the UI.

REST API​

The REST API lets you send HTTP requests to the Release server and get JSON responses back. You can access the API at a URL in the format http://[host]:[port]/[context-root]/[service-resource].

For example:

GET http://localhost:5516/api/v1/releases

Use the REST API to connect Release to CI/CD pipelines, monitoring tools, dashboards, or any system that can make HTTP calls.

Prerequisites​

  • A running Release instance that is reachable over the network.
  • An HTTP client such as curl, Postman, Python requests, or a CI/CD tool like Jenkins or GitHub Actions.
  • Authentication credentials. Release supports HTTP Basic Authentication, Personal Access Tokens, and OAuth2 tokens.

What You Can Do With It​

  • Start a new release from a template and pass in variable values.
  • Check the status of a running release, phase, or task.
  • Complete, fail, skip, or reassign tasks.
  • Search for releases by name, status, or tags.
  • Create, update, or delete templates.
  • Import and export release templates.
note

All templates, releases, phases, and tasks have identifiers in the format Applications/ReleaseXXXXXXXXX. To find an identifier, open the template or release in a browser and look at the last part of the URL. See How to Find Identifiers for REST API.

For more information, see REST API Reference.