Skip to main content

4.3 ext API endpoints (the ones cogwork actually calls)

MethodPathScopecogwork feature
GET/api/ext/releasesreleases:readrelease list
GET/api/ext/releases/{id}releases:readrelease ticket details
PUT/api/ext/releases/{id}/statusreleases:write-status(not used by cogwork; reserved for Jenkins pipelines reporting deploy results automatically)
PUT/api/ext/releases/{id}/feedbackreleases:write-feedbackrelease feedback (status / urgent / rollback)
GET/api/ext/systems/{systemId}/jenkins-jobsjenkins-jobs:readjob list of the Jenkins run panel
GET/api/ext/config-server-changesconfig-server:readConfig Server pending list
PUT/api/ext/config-server-changes/{id}config-server:writemark a Config Server change done after applying it

The API key cogwork uses must carry all of the scopes releases:read, releases:write-feedback, jenkins-jobs:read, config-server:read and config-server:write; it is configured under Admin → Credentials → API keys.