GithubActionsService

TerminateGithubActionsJob

Terminate the compute resource for a queued or running GitHub Actions job.

post/depot.core.v1.GithubActionsService/TerminateGithubActionsJob

Request

  • Base URL
    https://api.depot.dev
  • Auth
    HTTP bearer

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

repositorystring

Connected GitHub repository containing the job, in owner/name format.

jobIdstring

Unique GitHub identifier for the job. Returned by ListGithubActionsJobs.

Response

Success

jobIdstring

Unique GitHub identifier for the job.

outcome'GITHUB_ACTIONS_TERMINATION_OUTCOME_UNSPECIFIED' | 'GITHUB_ACTIONS_TERMINATION_OUTCOME_REQUESTED' | 'GITHUB_ACTIONS_TERMINATION_OUTCOME_ALREADY_REQUESTED' | 'GITHUB_ACTIONS_TERMINATION_OUTCOME_ALREADY_TERMINAL' | 'GITHUB_ACTIONS_TERMINATION_OUTCOME_NO_ACTIVE_COMPUTE'
status'GITHUB_ACTIONS_JOB_STATUS_UNSPECIFIED' | 'GITHUB_ACTIONS_JOB_STATUS_QUEUED' | 'GITHUB_ACTIONS_JOB_STATUS_WAITING' | 'GITHUB_ACTIONS_JOB_STATUS_RUNNING' | 'GITHUB_ACTIONS_JOB_STATUS_FINISHED'

Changes

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