Skip to main content

API Git Integration

APIs can be linked to Git repositories to sync specifications and documentation automatically.

Prerequisites​

Before connecting an API to a Git repository, you need to set up Git credentials.

Get Git configuration for an API​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apis/<api-id>/git" \
  -H "Authorization: Bearer <your-token>"
curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apis/<api-id>/git" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "gitUrl": "git@github.com:your-org/your-api-repo.git",
    "gitCredential": "<git-credential-id>"
  }'

Sync from Git​

Trigger a sync to pull the latest specification from the linked repository:

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apis/<api-id>/git/sync" \
  -H "Authorization: Bearer <your-token>"

Remove Git configuration​

curl -X DELETE "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apis/<api-id>/git" \
  -H "Authorization: Bearer <your-token>"

List Git branches/tags​

Retrieve available branches and tags from the connected repository:

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apis/<api-id>/git/refs" \
  -H "Authorization: Bearer <your-token>"