Deployment API

Create a new deployment record in Hivel

Overview

The Hivel Deployment API enables the submission of deployment data to Hivel, allowing for precise calculation of metrics such as deployment frequency.

Endpoint

POST https://app.hivel.ai/hivelapi/v1/deployment

Request Parameters

Request Example

curl -X POST "https://app.hivel.ai/hivelapi/v1/deployment" \
     -H "Authorization: Bearer YOUR_API_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
           "repo_url": "https://github.com/your-repo/project.git",
           "commit_hash": "d30b9416",
           "timestamp": "2024-08-01T12:34:56Z",
           "environment": "staging",
           "build_number": "build-2024-08-01-001",
           "pr_number": "44"
         }'

Response

{
  "message": "Success",
  "deployment_id": 1245,
}
  • 400 - Bad Request

  • 401 - Unauthorized

  • 500 - Internal Server Error

Last updated