builds

Get Build Monitor File Availability

Whether the download can be offered for this build, and if not, why.

Lets the UI explain itself before the user clicks instead of after a round trip to a machine that was never going to answer.

get/builds/{build_id}/build-monitor-file/availability

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/builds/{build_id}/build-monitor-file/availability
  • Auth: HTTP bearer

Path parameters

build_idstring uuid required

Headers

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

Response

Successful Response

availableboolean required
reason'build_in_progress' | 'no_initiator' | 'grid_unavailable' | 'data_sharing_disabled' | 'grid_offline' | 'unsupported_manager' | 'unsupported_platform'

Why the on-demand Build Monitor download cannot be offered for a build.

Each value is a different sentence to the user, which is the whole point: "this grid's manager is too old" and "nobody is listening on that grid" both mean no download, but only one of them is worth waiting for.

minimum_manager_versionstring nullable
manager_versionstring nullable

Changes

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