API Reference
  1. ChangeTrax API
  2. Deployment Gates

Run a deployment gate check

post
https://app.changetrax.io/api/v1/deployment-gates/check

Evaluates whether a deployment is permitted according to the matching policy and the RFC/Release status in ChangeTrax.
Use this endpoint from your CI/CD pipeline (GitHub Actions, Azure DevOps, Jenkins, etc.) immediately before deploying.

Typical response flow:

  • result: Allowed — deploy is safe to proceed
  • result: AllowedWithWarnings — proceed with caution; review warnings
  • result: Denied — block the deployment; review blockers and nextActions

Set dryRun: true to evaluate rules without recording the check.

Requires Enterprise plan. Authenticate with an API key scoped to gates:check.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string | null
string | null
string
required
length ≤ 100
string | null
string | null
string | null
string | null
string | null
string | null
string | null
affectedSystemIds
array of integers | null
affectedSystemIds
affectedSystemKeys
array of strings | null
affectedSystemKeys
date-time | null
date-time | null
string | null
boolean
Defaults to false

When true, evaluates gate rules without persisting the check record.

metadata
object | null
Response

Updated about 2 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?