ReferenceHTTP APIWorkspace settings

Replace the GitHub Packages allowlist (owner or admin)

PUT
/v1/workspaces/{id}/github-packages/allowlist

Replaces the whole allowlist, at most 200 entries. Each entry names a registry (npm or rubygems), a GitHub owner and a package name or *; repository_id (a catalog repository id) or agent_id narrows it to sessions of that repository or agent. Owners compare case-insensitively. revision is the one last read: a stale one is 409 REVISION_CONFLICT. Takes effect from the next request; a session's npm scopes and gem sources follow the owners named here from its next claim. Writes a set_github_packages_allowlist receipt. API keys are refused.

Auth: cookie session only; no scope. Idempotency-Key: ignored.

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 workspace'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

Header Parameters

X-Requested-With?"werft-web"

Required with a cookie session: the literal werft-web.

Value in"werft-web"

Request Body

application/json
  1. body
allowlist*array<>
Itemsitems <= 200
revision*integer
Range0 <= value <= 9007199254740991

Response Body

Stored; the receipt and the settings.

application/json
  1. response
token*
allowlist*array<>
Itemsitems <= 200
revision*integer
Range0 <= value <= 9007199254740991
receipt_id*string
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
Example Request
curl -X PUT 'https://example.com/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/github-packages/allowlist' \  -H 'Content-Type: application/json' \  -d '{  "allowlist": [    {      "registry": "rubygems",      "owner": "acme",      "name": "acme-auth",      "repository_id": "billing",      "agent_id": null    }  ],  "revision": 0}'
Example Response
{  "receipt_id": "c4a1e9d2-7b3f-4e8a-a6c5-1d2e3f4a5b6c",  "token": {    "configured": false,    "last4": null,    "login": null,    "expires_at": null,    "updated_at": null,    "updated_by": null  },  "allowlist": [    {      "registry": "rubygems",      "owner": "acme",      "name": "acme-auth",      "repository_id": "billing",      "agent_id": null    }  ],  "revision": 1}