API-referentie

Releases

Endpoint POST /api/v1/releases

Roep dit aan vanuit je deploy-pipeline (of gebruik blipit releases new). Met een GitHub-token opgeslagen bij het project haalt Blipit de commits zelf op; anders gebruikt het de commits die je stuurt.

1Request

Geheime sleutel in X-Blipit-Key. Body tot 2 MB: version (verplicht, tot 256 tekens), commit en previous_commit (git-sha's, 7 tot 40 hex), repo (owner/name), commits (optionele lijst uit git log: sha, message, author, gewijzigde bestanden, tot 250). Zonder previous_commit bewaart Blipit de commits na de commit van de vorige release, of alleen de head bij een eerste release.

sh
curl https://in.blipit.io/api/v1/releases \
  -H "Content-Type: application/json" -H "X-Blipit-Key: <secret key>" \
  -d '{"version":"shop@1.4.2","commit":"9fceb02a","previous_commit":"3a1c7f0d","repo":"acme/shop"}'

2Antwoorden

200 {version, commits, source (github, cli of null), previous_commit, warning?}. De warning zegt wanneer de GitHub-opzoeking is mislukt en de CLI-commits zijn gebruikt. 400 bij een ongeldige version, sha of repo. 401 onbekende sleutel, 403 publieke sleutel.

Goed om te weten

  • repo mag alleen owner/name zijn; alles met @, //, .., ?, # of extra segmenten wordt geweigerd, zodat GitHub-aanroepen alleen ooit api.github.com/repos/owner/name bereiken.
  • De GitHub compare-fetch heeft een time-out van 10 seconden en leest gewijzigde bestanden voor de nieuwste 30 commits.

Kom je er niet uit? Mail support@blipit.io. Sleutels en de exacte DSN van elk project staan onder API-sleutels in app.blipit.io.