リファレンスHTTP APIAgents

How the agent's pull request bodies differ from the workspace's

GET
/v1/agents/{id}/github/pull-request

pull_request holds formatting (inherit follows the workspace; on or off overrides it), template (markdown up to 16 KiB that stands in for the workspace's default_template; null uses the workspace's) and template_name (which file of a repository's .github/PULL_REQUEST_TEMPLATE/ directory to use when it holds several; matched to the names found there, never used as a path). An agent with nothing saved reads as inherit, no template, no name, with pull_request_revision 0. Kept apart from the agent's GitHub settings: saving it does not make the agent's sessions follow those instead of their release. Whoever manages the agent reads it, and so do the live members of its managing team.

Auth: cookie session only; no scope.

Authorization

cookieSession
cookie__Host-werft_session<token>

For the web console: the browser session cookie set by POST /v1/auth/login. It holds the scopes of the user's workspace role (owner: all; admin and member: all but sessions:recover). Requests other than GET must also send X-Requested-With: werft-web.

Path Parameters

id*string

The agent's id.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Response Body

The agent's values and the revision that guards them.

application/json
  1. response
pull_request*
pull_request_revision*integer
Range0 <= value <= 9007199254740991
Example Request
curl -X GET 'https://example.com/v1/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/github/pull-request'
Example Response
{  "pull_request": {    "formatting": "inherit",    "template": null,    "template_name": "feature.md"  },  "pull_request_revision": 2}