Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[PKG-7606] API docs for registry tokens update #2975

Merged
merged 2 commits into from
Sep 12, 2024
Merged

[PKG-7606] API docs for registry tokens update #2975

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed25663
api docs for registry tokens update
ensvo Sep 11, 2024
10057c5
Merge remote-tracking branch 'docs-public/main' into ev-packages-api-…
gilesgas Sep 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions pages/apis/rest_api/packages/registry_tokens.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,3 +92,57 @@ curl -H "Authorization: Bearer $TOKEN" \
Required scope: `read_registries`

Success response: `200 OK`

## Update a registry token

```bash
curl -H "Authorization: Bearer $TOKEN" \
-X POST "https://api.buildkite.com/v2/packages/organizations/#{org.slug}/registries/#{registry.slug}/tokens/#{id}" \
-H "Content-Type: application/json" \
-d '{
"description": "Usher"
}'
```

```json
{
"id": "0191b6a2-aa51-70d0-8a5f-aabce115b0fd",
"graphql_id": "UmVnaXN0cnlUb2tlbi0tLTAxOTFiNmEyLWFhNTEtNzBkMC04YTVmLWFhYmNlMTE1YjBmZA==",
"description": "Usher",
"url": "http://api.buildkite.com/v2/packages/organizations/my_great_org/registries/my-registry/tokens/0191b6a2-aa51-70d0-8a5f-aabce115b0fd",
"created_at": "2024-09-03T06:46:39.441Z",
"created_by": {
"id": "0191b13b-0eb6-470d-a4c0-2085974f3580",
"graphql_id": "VXNlci0tLTAxOTFiMTNiLTBlYjYtNDcwZC1hNGMwLTIwODU5NzRmMzU4MA==",
"name": "Eminem",
"email": "eminem@buildkite.com",
"avatar_url": null,
"created_at": "2024-09-02T05:35:23.318Z"
},
"organization": {
"id": "018a456f-e581-44b6-c5a4-1d8a5f7094ee",
"slug": "my_great_org",
"url": "https://api.buildkite.com/v2/analytics/organizations/my_great_org",
"web_url": "https://buildkite.com/organizations/my_great_org"
},
"registry": {
"id": "018f56ef-9ef4-70f0-aba2-0f4578e3d69d",
"graphql_id": "UmVnaXN0cnktLS0wMThmNTZlZi05ZWY0LTcwZjAtYWJhMi0wZjQ1NzhlM2Q2OWQ=",
"slug": "my-registry",
"url": "http://api.buildkite.com/v2/packages/organizations/my_great_org/registries/my-registry",
"web_url": "http://buildkite.com/organizations/buildkite/my_great_org/registries/my-registry"
}
}
```

Required [request body properties](/docs/api#request-body-properties):

<table class="responsive-table">
<tbody>
<tr><th><code>description</code></th><td>Description of the token<br><em>Example:</em> <code>"Usher"</code>.</td></tr>
</tbody>
</table>

Required scope: `write_registries`

Success response: `200 OK`
Loading