Skip to content

Document SCALE REST API snapshot and 25.10 CA migration #4756

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

Closed
PabloLIONHermes wants to merge 1 commit into from
Closed

Document SCALE REST API snapshot and 25.10 CA migration #4756

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 23 additions & 2 deletions static/api/scale_rest_api.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,41 @@
<!DOCTYPE html>
<html>
<head>
<title>TrueNAS REST API Documentation</title>
<title>TrueNAS SCALE 24.10-RC.1 REST API Documentation</title>
<link rel="stylesheet" href="//unpkg.com/swagger-ui-dist@3.26.0/swagger-ui.css" />
<script src="//unpkg.com/swagger-ui-dist@3.26.0/swagger-ui-bundle.js"></script>
<style>
.scheme-container { display:none; }
.try-out { display:none; }
.api-version-notice {
border-left: 4px solid #f0ad4e;
margin: 1rem;
padding: 1rem;
}
</style>
</head>
<body>
<div class="api-version-notice" role="note">
<strong>Version notice:</strong>
This page is a snapshot of the TrueNAS SCALE 24.10-RC.1 REST API.
The <code>certificateauthority</code> endpoints shown here, including <code>GET /certificateauthority</code>
(<code>certificateauthority.query</code>), belong to the legacy API represented by this snapshot. TrueNAS 25.10
removes the built-in certificate authority (CA) service and its <code>certificateauthority.*</code> methods. During
an upgrade to 25.10, TrueNAS migrates existing CAs to certificate records. In the 25.10 JSON-RPC 2.0 API, call
<a href="https://api.truenas.com/v25.10/api_methods_certificate.query.html"><code>certificate.query</code></a> with
<code>[[&quot;cert_type_CA&quot;, &quot;=&quot;, true]]</code> as the
<code>filters</code> parameter to list CA certificates. TrueNAS provides no direct replacement for creating CAs,
signing certificate signing requests (CSRs), or revoking
certificates through the removed CA service. Use an external CA to sign CSRs and manage revocation, or use ACME for
supported certificate issuance. See the
<a href="https://www.truenas.com/docs/scale/25.10/gettingstarted/versionnotes/">TrueNAS 25.10 version notes</a>
for details.
</div>
<div id="root" class="swagger-ui" />
<script>
const ui = SwaggerUIBundle({
url: 'https://www.truenas.com/docs/files/scale_24.10-rc1_apiv2.json',
dom_id: '#root'
});
</script>
</body>
</body>