Skip to content

SDK 1.18.0 release notes and metadata endpoint docs #3882

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

Merged
laverya merged 3 commits into from
Mar 13, 2026
Merged

SDK 1.18.0 release notes and metadata endpoint docs #3882

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d641f17
SDK 1.18.0 release notes and metadata endpoint docs
laverya Mar 13, 2026
491bbf6
Update replicated-sdk-apis.md
paigecalvert Mar 13, 2026
9a2a4ea
bump dependency yaml
paigecalvert Mar 13, 2026
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
2 changes: 1 addition & 1 deletion docs/partials/replicated-sdk/_dependency-yaml.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
dependencies:
- name: replicated
repository: oci://registry.replicated.com/library
version: 1.17.1
version: 1.18.0
```

For the latest version information for the Replicated SDK, see the [replicated-sdk repository](https://github.com/replicatedhq/replicated-sdk/releases) in GitHub.
47 changes: 47 additions & 0 deletions docs/reference/replicated-sdk-apis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,53 @@ Response: Status `201` Created
}
```

## supportbundle
Copy link
Copy Markdown
Contributor

@github-actions github-actions bot Mar 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'supportbundle'?

Copy link
Copy Markdown
Contributor

@github-actions github-actions bot Mar 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[Replicated.Headings] 'supportbundle' should use sentence case.


### POST /supportbundle/metadata
Copy link
Copy Markdown
Contributor

@github-actions github-actions bot Mar 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[Replicated.Headings] 'POST /supportbundle/metadata' should use sentence case.


Set support bundle metadata (key-value pairs) by replacing any existing metadata.

The SDK stores metadata as top-level keys in a Kubernetes secret named `replicated-support-metadata` in the SDK namespace. You can use the `supportBundleMetadata` collector to include this metadata in support bundles. For more information about this collector, see [Support Bundle Metadata](https://troubleshoot.sh/docs/collect/support-bundle-metadata) in the Troubleshoot documentation.

```bash
POST http://replicated:3000/api/v1/supportbundle/metadata
```

Request:

```json
{
"data": {
"key1": "value1",
"key2": "value2"
}
}
```

Response: Status `200` OK

### PATCH /supportbundle/metadata
Copy link
Copy Markdown
Contributor

@github-actions github-actions bot Mar 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[Replicated.Acronyms] Spell out 'PATCH' on first use, if it's unfamiliar to the audience.

Copy link
Copy Markdown
Contributor

@github-actions github-actions bot Mar 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[Replicated.Headings] 'PATCH /supportbundle/metadata' should use sentence case.


Merge support bundle metadata (key-value pairs) with any existing metadata. `PATCH /supportbundle/metadata` adds new keys and updates existing keys. It preserves any keys excluded from the request.

The SDK stores metadata as top-level keys in a Kubernetes secret named `replicated-support-metadata` in the SDK namespace. You can use the `supportBundleMetadata` collector to include this metadata in a support bundle. For more information about this collector, see [Support Bundle Metadata](https://troubleshoot.sh/docs/collect/support-bundle-metadata) in the Troubleshoot documentation.

```bash
PATCH http://replicated:3000/api/v1/supportbundle/metadata
```

Request:

```json
{
"data": {
"key3": "value3"
}
}
```

Response: Status `200` OK

## license

### GET /license/info
Expand Down
7 changes: 7 additions & 0 deletions docs/release-notes/rn-replicated-sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,13 @@ pagination_prev: null

This topic contains release notes for the [Replicated SDK](/vendor/replicated-sdk-overview). The release notes list new features, improvements, bug fixes, known issues, and breaking changes.

## 1.18.0

Released on March 13, 2026

### New features {#new-features-1-18-0}
* Adds `POST /api/v1/supportbundle/metadata` and `PATCH /api/v1/supportbundle/metadata` endpoints for configuring support bundle metadata. See [POST /supportbundle/metadata](/reference/replicated-sdk-apis#post-supportbundlemetadata) and [PATCH /supportbundle/metadata](/reference/replicated-sdk-apis#patch-supportbundlemetadata) in _Replicated SDK API_.

## 1.17.1

Released on March 5, 2026
Expand Down
Loading