v1
latestOpenAPI 3.0.22026-07-26207170320.9 KBServices
List events
List recent events that occurred for the service with the provided ID.
get/services/{serviceId}/events
Path parameters
serviceIdstring required
The ID of the service
Query parameters
type'artifact_fetch_failed' | 'artifact_source_changed' | 'autoscaling_config_changed' | 'autoscaling_ended' | 'autoscaling_started' | 'branch_deleted' | 'build_ended' | 'build_started' | 'commit_ignored' | 'cron_job_run_ended' | 'cron_job_run_started' | 'deploy_ended' | 'deploy_started' | 'disk_created' | 'disk_updated' | 'disk_deleted' | 'image_pull_failed' | 'initial_deploy_hook_ended' | 'initial_deploy_hook_started' | 'instance_count_changed' | 'job_run_ended' | 'maintenance_mode_enabled' | 'maintenance_mode_uri_updated' | 'maintenance_ended' | 'maintenance_started' | 'pipeline_minutes_exhausted' | 'plan_changed' | 'pre_deploy_ended' | 'pre_deploy_started' | 'server_available' | 'server_failed' | 'server_hardware_failure' | 'server_restarted' | 'service_resumed' | 'service_suspended' | 'suspender_added' | 'suspender_removed' | 'zero_downtime_redeploy_ended' | 'zero_downtime_redeploy_started' | 'auto_deploy_disabled' | 'auto_deploy_enabled'
The type of event to filter to
startTimestring date-time
Example:2021-06-17T08:15:30Z
Epoch/Unix timestamp of start of time range to return. Defaults to now() - 1 hour.
endTimestring date-time
Example:2021-06-17T08:30:30Z
Epoch/Unix timestamp of end of time range to return. Defaults to now().
cursorstring
The position in the result list to start from when fetching paginated results. For details, see Pagination.
limitinteger
Defaults to 20
The maximum number of items to return. For details, see Pagination.
Response
Successful response