Actions

Dispatch a workflow

GitCafe Actions only: captures a workflow_dispatch of one workflow file at the commit the branch or tag names now. Dispatch inputs are not supported; workflow defaults apply and workflows with required inputs without defaults cannot run through this endpoint. This does not dispatch workflows on GitHub, including for mirrored repositories; use GitHub workflow dispatch for those. Native GitCafe Actions must be enabled (otherwise ACTIONS_DISABLED, 409); enabling it does not enable GitHub dispatch. Replaying requestKey returns the same trigger; discovery then publishes the run if the workflow declares workflow_dispatch. Requires authenticated authority and enforces current resource policy.

post/api/repos/{owner}/{repo}/actions/dispatch

Request

  • Base URL
    https://git.cafe
  • Auth
    • API key in cookie gc-session
    • or HTTP bearer
    • or HTTP basic
    • or HTTP token
    • or OAuth 2
      Authorization code: /api/oauth/authorize
      Token URL: /api/oauth/token scopes: repo:contents:write

Path parameters

ownerstring required
repostring required

Request body

workflowPathstring required
refstring required
requestKeystring required

Response

Response for status 202

triggerIdstring required
replayedboolean required

Changes

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