Skip to content

Document SCALE REST API snapshot and 25.10 CA migration - #4756

Closed
PabloLIONHermes wants to merge 1 commit into
truenas:masterfrom
PabloLIONHermes:docs/25.10-ca-api-migration
Closed

Document SCALE REST API snapshot and 25.10 CA migration#4756
PabloLIONHermes wants to merge 1 commit into
truenas:masterfrom
PabloLIONHermes:docs/25.10-ca-api-migration

Conversation

@PabloLIONHermes

Copy link
Copy Markdown

Summary

  • Identify the unversioned SCALE REST API page as a 24.10-RC.1 snapshot.
  • Identify GET /certificateauthority as the legacy REST route for certificateauthority.query.
  • Document the removal of certificateauthority.* and migration of existing CAs in TrueNAS 25.10.
  • Point CA listing callers to certificate.query with a cert_type_CA = true filter.
  • Clarify that CA creation, CSR signing, and CA-service revocation have no direct replacement.

Why

static/api/scale_rest_api.html currently embeds scale_24.10-rc1_apiv2.json, but the rendered page does not show that version boundary. Readers can therefore mistake the legacy certificateauthority resources for current 25.10 API methods.

TrueNAS 25.10 removed the CA service in truenas/middleware#15972. Existing CA rows migrate into certificate records, which remain discoverable through certificate.query using the cert_type_CA field. External CAs handle CSR signing and revocation, while ACME provides a supported certificate-issuance workflow.

Related implementation and UI PRs confirm this direction, and searches found no existing documentation issue or PR for this API wrapper or endpoint-level mapping.

Validation

  • Parsed the edited standalone HTML successfully.
  • Ran git -c core.whitespace=cr-at-eol diff --check.
  • Confirmed all linked official TrueNAS pages return HTTP 200.
  • Built the full site successfully with Hugo Extended 0.145.0 (CI) and 0.157.0 (README).
  • Verified desktop and mobile rendering with no new console errors or notice overflow.

Thanks for contributing to TrueNAS documentation! By opening a Pull Request, you're acknowledging that your changes will be distributed under the Creative Commons 4.0 license.

@PabloLIONHermes
PabloLIONHermes requested a review from a team as a code owner September 2, 2026 12:55
@tonyriv3 tonyriv3 added the Technical Writer Review (DP) A technical writer is reviewing the PR. label Sep 2, 2026
@PabloLIONHermes

Copy link
Copy Markdown
Author

Related implementation and documentation context

For reviewers, this change follows the TrueNAS 25.10 direction already established by:

This PR complements documentation PR #4127 rather than duplicating it. That PR updates the 25.10 UI guidance; this PR updates static/api/scale_rest_api.html, the unversioned legacy 24.10-RC.1 REST snapshot, to make the version boundary visible and provide API consumers with the endpoint-level 25.10 migration: use certificate.query with cert_type_CA = true to list CA certificates.

@DjP-iX

DjP-iX commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Thanks for the detailed writeup and the research into the 25.10 CA migration.

Unfortunately I don't think this is the right file to update. static/api/scale_rest_api.html isn't actually linked from anywhere in the live site. It's left over from before the API docs moved to a dedicated site and it's frozen on a 24.10-rc1 snapshot because nothing has pointed to it in some time.

The current API docs strategy is:

  • truenas.com/docs/scale/api/ (https://www.truenas.com/docs/scale/api/) — the "API Reference" page in this docs repo, which explains how to reach API docs (built-in /api/docs/ on the appliance, or the external site below)
  • https://api.truenas.com — the actual up-to-date, versioned API documentation, with a dropdown to select the API version you're targeting, including 25.10 certificate handling

Since this file is an orphan, we're planning to remove it (along with a few sibling files in the same directory) in a follow-up cleanup PR rather than patch it further. I'll close this one out, but thanks again for flagging the stale content.

@DjP-iX DjP-iX closed this Sep 8, 2026
@PabloLIONHermes

Copy link
Copy Markdown
Author

@DjP-iX Np problem. Thanks for your contribution and for the reviewing. (from human)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Technical Writer Review (DP) A technical writer is reviewing the PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants