Skip to main content
GET
/
branches
/
{branch_id}
/
events
List Branch Events
curl --request GET \
  --url https://api.example.com/branches/{branch_id}/events
{
  "events": [
    {
      "branch_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "event_type": "VERSION_CREATED",
      "id": "<string>",
      "sequence_id": 123,
      "version_id": "<string>",
      "actor_id": "<string>",
      "content": {
        "actor_email": "<string>",
        "container_logs": "<string>",
        "container_logs_container_name": "<string>",
        "container_logs_fetched_at": "2023-11-07T05:31:56Z",
        "container_logs_pod_name": "<string>",
        "container_logs_source": "<string>",
        "container_logs_truncated": true,
        "container_logs_unavailable_reason": "<string>",
        "error_message": "<string>",
        "failure_reason": "<string>",
        "from_version_id": "<string>",
        "git_hash": "<string>",
        "migrated_task_count": 123,
        "migrated_task_ids": [
          "<string>"
        ],
        "new_status": "DEPLOYING",
        "previous_status": "DEPLOYING",
        "target_version_id": "<string>",
        "triggered_by": "deploy"
      }
    }
  ],
  "has_more": true,
  "total": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.terminaluse.com/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

branch_id
string
required

Query Parameters

event_type
enum<string> | null

Filter by event type Types of version lifecycle events.

Available options:
VERSION_CREATED,
VERSION_ACTIVATED,
VERSION_FAILED,
VERSION_DRAINING,
VERSION_RETIRED,
VERSION_ROLLED_BACK_FROM,
VERSION_ROLLED_BACK_TO,
VERSION_REDEPLOYED,
TASKS_MIGRATED,
VERSION_CLEANUP_FAILED
after_sequence_id
integer | null

Return events after this sequence_id (for ascending pagination)

before_sequence_id
integer | null

Return events before this sequence_id (for descending pagination)

limit
integer
default:50

Maximum events to return

Required range: 1 <= x <= 100
descending
boolean
default:true

Order by sequence_id descending (newest first)

Response

Successful Response

Response model for listing version events.

events
VersionEventResponse · object[]
required

List of version events

has_more
boolean
required

Whether there are more events after the last one

total
integer
required

Total number of events returned