back-office

Get Tenant Ci Runner Usage

get/back-office/tenants/{public_id}/ci-runner-usage

Request

  • Base URL: https://api.incredibuild.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.incredibuild.com/back-office/tenants/{public_id}/ci-runner-usage
  • Auth: HTTP bearer

Path parameters

public_idstring uuid required

Query parameters

monthstring nullable

UTC month, YYYY-MM.

Headers

x-public-tenant-idstring uuid nullable
x-public-user-idstring uuid nullable

Response

Successful Response

monthstring required
minutesinteger required

Minutes of jobs that ended in the month (UTC).

in_flight_minutesinteger required

Running jobs so far; current month only.

running_jobsinteger required
capinteger nullable required
cap_enforcedboolean required

New jobs are blocked at the cap; off means the cap only notifies.

percent_usednumber nullable required

(minutes + in_flight_minutes) / cap.

resets_atstring date-time required
cap_state'none' | 'warning' | 'capped' required

warning at 80% of the cap, capped at 100%.

blocked_jobsinteger required

Jobs not started in the month because of the cap.

other_repositories_minutesinteger required

Repos that never had a CI runner.

Changes

No recorded changes to this operation across all 1 revision of this API.