Docs
Search docs

Pin a workflow

PUT/api/repos/{owner}/{repo}/workflows/{workflow_id}/pin

pinWorkflow

Pins the workflow for the authenticated user in this repository's Actions sidebar. Idempotent — re-pinning keeps the original pin time. Any user who can view the repository can pin its workflows. 404 when the workflow does not belong to the repository.

Requires authentication using a bearer token or a session cookie — see tokens and scopes.

curl

curl -X PUT 'https://neosource.dev/api/repos/OWNER/REPO/workflows/WORKFLOW_ID/pin' \
  -H 'Authorization: Bearer $NEOSOURCE_TOKEN'

fetch

fetch("https://neosource.dev/api/repos/OWNER/REPO/workflows/WORKFLOW_ID/pin", {
  method: "PUT",
  headers: {
    Authorization: "Bearer $NEOSOURCE_TOKEN",
  },
});

Path parameters

ownerrequired

Repository owner or organization slug.

string

reporequired

Repository name.

string

workflow_idrequired

The workflow's id (`WorkflowResponse.id`).

string

Responses

204Workflow pinned

Standard errors

Bodies documented once for the whole API — see standard errors.

  • 400Bad Request — one of: invalid_input
  • 401Authentication required
  • 403Forbidden — one of: forbidden
  • 404Not Found — one of: not_found
  • 423Locked — one of: busy
  • 429Rate limited — retry after the `Retry-After` header
  • 500Internal server error
  • 503Service temporarily unavailable / at capacity — retry after the `Retry-After` header
  • 504Gateway timeout — the request exceeded the server's handling budget