COcomposal
github_runner_checkout

Prepare a runner's Git object cache

Internal runner protocol. Requires an expiring invocation-attempt credential. User API tokens do not authorize this endpoint. Repository scope comes from the runner pool; source credentials are never returned.

post/api/v1/github_runner_checkout

Request

  • Base URL
    https://composal.com (the document declares no server; this is the origin it was published from)
  • URL
    https://composal.com/api/v1/github_runner_checkout
  • Auth
    • HTTP bearer
    • or HTTP bearer

Request body

OR

Example request

{
  "repository": "acme/monorepo"
}

Response

Pending, prepared or failed Git object cache preparation

status'pending' | 'ready' | 'failed' required
ticketstring
commitstring
object_oidstring
refsobject
cache_hitboolean
source'cache' | 'composal' | 'github'
prepare_secondsnumber

Changes

No recorded changes to this operation across all 3 revisions of this API.