platform_manager.go (package eai)
Source: sdks/go/platform_manager.go. Back to the Go SDK reference index.
This page is generated by tools/docs/gen_sdk_reference.py from the SDK sources and the OpenAPI text folders. Do not edit it by hand: change the source and regenerate.
Class PlatformManagerService
PlatformManagerService groups the endpoints of: Platform Manager space of the console (ADR-0128). Every route needs platform_admin; the Control Plane relays the call to the Navin Platform Manager on behalf of the caller, whose RBAC, approvals and stop rules decide. A Manager refusal comes back with its status and a platform_manager_.
PlatformManagerService.ApproveDRExercise
ApproveDRExercise(ctx context.Context, exerciseID string, opts ...CallOption) (json.RawMessage, error)
Approve a DR exercise. Adds the approval of the user to a DR exercise; the Manager refuses a self approval. Audited (platform_manager.dr.exercise.approve) with the new status. Requires platform_admin.
Route: /v1/platform-manager/dr/exercises/{exercise_id}/approve (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. exerciseIDstringyes Identifier of the DR exercise in the Manager. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Approve a DR exercise". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.ApproveRestore
ApproveRestore(ctx context.Context, planID string, opts ...CallOption) (json.RawMessage, error)
Approve a restore plan. Adds the approval of the user to a restore plan; the Manager refuses a self approval and counts two distinct approvers. Audited (platform_manager.restore.approve) with the new status and approval count. Requires platform_admin.
Route: /v1/platform-manager/backup/restores/{plan_id}/approve (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. planIDstringyes Identifier of the restore plan in the Manager. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Approve a restore plan". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.BackupJobs
BackupJobs(ctx context.Context, opts ...CallOption) (json.RawMessage, error)
List the backup jobs. Backup jobs of the Manager with their status, relayed on behalf of the user (backup:read there). Requires platform_admin.
Route: /v1/platform-manager/backup/jobs (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "List the backup jobs". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.BackupPlans
BackupPlans(ctx context.Context, opts ...CallOption) (json.RawMessage, error)
List the backup plans. Backup policies (scope, interval, retention, immutability) and the late or failed alerts of the Manager. Requires platform_admin.
Route: /v1/platform-manager/backup/plans (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "List the backup plans". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.Backups
Backups(ctx context.Context, opts ...CallOption) (json.RawMessage, error)
List the backup artefacts. Backup artefacts with SHA-256, size and the outcome of their last verification, relayed from the Manager (backup:read there). Requires platform_admin.
Route: /v1/platform-manager/backup/backups (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "List the backup artefacts". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.Catalog
Catalog(ctx context.Context, opts ...CallOption) (json.RawMessage, error)
List the Manager catalog. Services of the Manager catalog (stack name, version and categories) with their display names, category, version, components, modes, methods, requirements, delivery (install, connect, job, package), layer and licence. Requires platform_admin.
Route: /v1/platform-manager/catalog (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "List the Manager catalog". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.CatalogService
CatalogService(ctx context.Context, service string, opts ...CallOption) (json.RawMessage, error)
Get the install descriptor of a service. Install descriptor of one catalog service: modes with their components and cardinalities, methods, requirements, sections and parameters with their defaults. A secret parameter never carries a default and says whether it is generated; templates and artefacts never leave the bridge. Requires platform_admin.
Route: /v1/platform-manager/catalog/{service} (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. servicestringyes Name of the catalog service. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Get the install descriptor of a service". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.Clusters
Clusters(ctx context.Context, opts ...CallOption) (json.RawMessage, error)
List the clusters. Clusters (environments) of the Navin Manager visible to the user. Requires platform_admin.
Route: /v1/platform-manager/clusters (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "List the clusters". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.Connect
Connect(ctx context.Context, clusterID string, body any, opts ...CallOption) (json.RawMessage, error)
Connect an existing service. Registers an existing service of the customer on behalf of the user and answers 201; the Manager checks services:install and the connect section of the descriptor, then health checks it. A connected service is never installed, started or stopped by the Manager. Secret fields are relayed and sealed by the Manager; the audit keeps the endpoint, TLS, method and field names only. Requires platform_admin.
Route: /v1/platform-manager/clusters/{cluster_id}/services/connect (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. clusterIDstringyes Identifier of the cluster in the Navin Manager. bodyanyyes The service to connect. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Connect an existing service". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.Connections
Connections(ctx context.Context, connType string, opts ...CallOption) (json.RawMessage, error)
List the connections. Existing connections of the types the portal binds (PostgreSQL, Redis, OIDC), filtered by type when given; the secret only says whether it is set. Needs connections:read in the Manager. Requires platform_admin.
Route: /v1/platform-manager/connections (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. connTypestringyes Connection type to keep (postgresql, redis or oidc), sent as the type query parameter; empty for every type. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "List the connections". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.Console
Console(ctx context.Context, opts ...CallOption) (json.RawMessage, error)
Get the console links. Whether the Manager is configured, the base address of its console (EAI_PLATFORM_MANAGER_CONSOLE_URL, else EAI_PLATFORM_MANAGER_URL) and the operator consoles (Opik, Grafana, Keycloak, LiteLLM, OpenSearch Dashboards): from their setting when set (source setting), else from the service of the same name the Manager installed or connected (source manager). A console address that is not https or that carries credentials is never returned (problem says why). Requires platform_admin.
Route: /v1/platform-manager/console (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Get the console links". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.CreateCluster
CreateCluster(ctx context.Context, body any, opts ...CallOption) (json.RawMessage, error)
Create a cluster. Creates a cluster (environment) in the Manager and answers 201; the delegated user needs clusters:create. Audited (platform_manager.cluster_create), allowed or refused. Requires platform_admin.
Route: /v1/platform-manager/clusters (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. bodyanyyes Name, mode, description and profile of the cluster. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Create a cluster". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.CreateConnection
CreateConnection(ctx context.Context, body any, opts ...CallOption) (json.RawMessage, error)
Save a connection. Saves an existing PostgreSQL, Redis or OIDC issuer as a Manager connection and answers 201 (the secret is sealed by the Manager and never returned). Install forms then bind a service to it. Needs connections:manage in the Manager. The audit keeps name, type, parameter keys and whether a secret was given. Requires platform_admin.
Route: /v1/platform-manager/connections (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. bodyanyyes The connection to save. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Save a connection". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.CreateEnrollmentToken
CreateEnrollmentToken(ctx context.Context, clusterID string, body any, opts ...CallOption) (json.RawMessage, error)
Create an enrollment token. Bootstrap token of the node agent and the register command to run on each machine, answered with 201; shown once, the token and the command are never written to the audit (only its id and expiry). Needs hosts:manage in the Manager. Requires platform_admin.
Route: /v1/platform-manager/clusters/{cluster_id}/enrollment-tokens (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. clusterIDstringyes Identifier of the cluster in the Navin Manager. bodyanyyes Lifetime and number of uses of the token. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Create an enrollment token". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.CreateVaultEntry
CreateVaultEntry(ctx context.Context, body any, opts ...CallOption) (json.RawMessage, error)
Add a vault entry. Adds a service to the IT vault (source manual) and answers 201 without the password nor the key. URL, login, password and key are sealed together with AES-256-GCM (key derived from the platform master key, entry id as associated data); only the name is stored in clear. A name already used answers 409 it_vault_name_taken; an empty name 422 validation_failed. Audited (it_vault.create, name only). Requires platform_admin.
Route: /v1/platform-manager/vault/entries (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. bodyanyyes The service to add. Unknown fields are refused. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Add a vault entry". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.DRExercises
DRExercises(ctx context.Context, opts ...CallOption) (json.RawMessage, error)
List the DR exercises. DR exercises with the observed RPO and RTO and whether each target was met (null when not measured). Requires platform_admin.
Route: /v1/platform-manager/dr/exercises (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "List the DR exercises". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.DRPlans
DRPlans(ctx context.Context, opts ...CallOption) (json.RawMessage, error)
List the DR plans. DR plans: mode, primary and secondary sites, the client's RPO and RTO targets (null until set). Requires platform_admin.
Route: /v1/platform-manager/dr/plans (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "List the DR plans". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.DecommissionHost
DecommissionHost(ctx context.Context, hostID string, opts ...CallOption) (json.RawMessage, error)
Decommission a machine. Decommissions a machine without components (agent stopped, certificate revoked) and answers 202 with the operation id. Audited (platform_manager.decommission), allowed or refused. Requires platform_admin.
Route: /v1/platform-manager/hosts/{host_id}/decommission (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. hostIDstringyes Identifier of the machine in the Manager. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Decommission a machine". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.DeleteConnection
DeleteConnection(ctx context.Context, connectionID string, opts ...CallOption) (json.RawMessage, error)
Delete a connection. Forgets a connection and answers 204; the Manager refuses (409 platform_manager_connection_in_use) while a service is bound to it. Needs connections:manage in the Manager. Audited, allowed or refused. Requires platform_admin.
Route: /v1/platform-manager/connections/{connection_id} (DELETE).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. connectionIDstringyes Identifier of the connection in the Manager. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Delete a connection". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.DeleteVaultEntry
DeleteVaultEntry(ctx context.Context, entryID string, opts ...CallOption) (json.RawMessage, error)
Delete a vault entry. Deletes a service of the IT vault and answers 204. An entry pre-filled from the platform settings comes back at the next import. Audited (it_vault.delete, name only). Unknown id: 404 it_vault_entry_not_found. Requires platform_admin.
Route: /v1/platform-manager/vault/entries/{entry_id} (DELETE).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. entryIDstringyes Identifier (UUID) of the vault entry. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Delete a vault entry". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.Disconnect
Disconnect(ctx context.Context, clusterID string, service string, opts ...CallOption) (json.RawMessage, error)
Disconnect a connected service. Forgets a connected service (the service itself is untouched); the Manager refuses while a consumer uses it. Audited (platform_manager.disconnect), allowed or refused. Requires platform_admin.
Route: /v1/platform-manager/clusters/{cluster_id}/services/{service}/connection (DELETE).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. clusterIDstringyes Identifier of the cluster in the Navin Manager. servicestringyes Name of the connected service. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Disconnect a connected service". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.EnrollmentTokens
EnrollmentTokens(ctx context.Context, clusterID string, opts ...CallOption) (json.RawMessage, error)
List the enrollment tokens. Bootstrap tokens of a cluster: prefix, expiry, uses and revocation (the token itself is never listed). Requires platform_admin.
Route: /v1/platform-manager/clusters/{cluster_id}/enrollment-tokens (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. clusterIDstringyes Identifier of the cluster in the Navin Manager. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "List the enrollment tokens". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.Host
Host(ctx context.Context, hostID string, opts ...CallOption) (json.RawMessage, error)
Get a machine. One machine with its facts (operating system, resources, agent version, last heartbeat). Requires platform_admin.
Route: /v1/platform-manager/hosts/{host_id} (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. hostIDstringyes Identifier of the machine in the Manager. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Get a machine". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.ImportVault
ImportVault(ctx context.Context, opts ...CallOption) (json.RawMessage, error)
Import the configured services into the vault. Pre-fills the vault with the services the platform is configured with (PostgreSQL, Redis, Keycloak, OpenBao, OpenFGA, OPA, LiteLLM, Qdrant, NATS, Temporal, LiveKit, Opik, ClickHouse, S3, Platform Manager, installer account of the portal), from the EAI_* settings. Only missing services are added: an entry is never overwritten, a deleted one comes back. Answers the created and skipped names. Audited (it_vault.import). The same import runs at each API start. Requires platform_admin.
Route: /v1/platform-manager/vault/import (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Import the configured services into the vault". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.Install
Install(ctx context.Context, clusterID string, body any, opts ...CallOption) (json.RawMessage, error)
Install catalog services. Installs catalog services on the chosen hosts, on behalf of the user, and answers 202 with the operation id; the Manager checks services:install, the modes, methods, placements and configuration, then starts the install operation. The audit keeps services, modes, methods, hosts and configured keys, never the configuration values. Requires platform_admin.
Route: /v1/platform-manager/clusters/{cluster_id}/services (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. clusterIDstringyes Identifier of the cluster in the Navin Manager. bodyanyyes Services to install and install options. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Install catalog services". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.Nodes
Nodes(ctx context.Context, clusterID string, opts ...CallOption) (json.RawMessage, error)
List the machines of a cluster. Hosts of the cluster as the Manager knows them (state, facts, agent). Requires platform_admin.
Route: /v1/platform-manager/clusters/{cluster_id}/nodes (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. clusterIDstringyes Identifier of the cluster in the Navin Manager. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "List the machines of a cluster". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.Operations
Operations(ctx context.Context, clusterID string, opts ...CallOption) (json.RawMessage, error)
List the operations of a cluster. Operations of the Manager on the cluster (install, start, stop, preflight, bootstrap...) with their target and status. Requires platform_admin.
Route: /v1/platform-manager/clusters/{cluster_id}/operations (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. clusterIDstringyes Identifier of the cluster in the Navin Manager. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "List the operations of a cluster". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.PlanRestore
PlanRestore(ctx context.Context, body any, opts ...CallOption) (json.RawMessage, error)
Plan a restore. Plans a restore of one artefact and answers 201 with the plan; the plan always precedes an execution and needs two approvers other than the requester. The Manager compares the target versions with the artefact. Executing the restore stays in the Manager console. Audited (platform_manager.restore.plan), allowed or refused. Requires platform_admin.
Route: /v1/platform-manager/backup/restores (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. bodyanyyes Artefact to restore and target environment. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Plan a restore". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.PreflightResults
PreflightResults(ctx context.Context, hostID string, opts ...CallOption) (json.RawMessage, error)
Read the preflight results. Results of the last preflight checks of a machine (check, status, message in both languages). Requires platform_admin.
Route: /v1/platform-manager/hosts/{host_id}/preflight (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. hostIDstringyes Identifier of the machine in the Manager. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Read the preflight results". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.RefreshFacts
RefreshFacts(ctx context.Context, hostID string, opts ...CallOption) (json.RawMessage, error)
Refresh the facts of a machine. Asks the node agent to collect the facts of the machine again (operating system, resources...) and answers 202 with the operation id. Audited (platform_manager.facts_refresh), allowed or refused. Requires platform_admin.
Route: /v1/platform-manager/hosts/{host_id}/facts/refresh (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. hostIDstringyes Identifier of the machine in the Manager. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Refresh the facts of a machine". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.RequestDRExercise
RequestDRExercise(ctx context.Context, body any, opts ...CallOption) (json.RawMessage, error)
Request a DR exercise. Requests a DR exercise of a DR plan and answers 201; the Manager applies its approval rule (dr:manage there). Completing the exercise and a real failover stay in the Manager console. Audited (platform_manager.dr.exercise.request), allowed or refused. Requires platform_admin.
Route: /v1/platform-manager/dr/exercises (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. bodyanyyes The DR plan to exercise. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Request a DR exercise". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.RequestOperation
RequestOperation(ctx context.Context, clusterID string, service string, body any, opts ...CallOption) (json.RawMessage, error)
Request a service operation. Forwards an operation (start, stop, restart, rolling restart, reinstall) with the user's identity and answers 202 with the operation id; the Manager decides (RBAC, approvals, stop rules). Audited (platform_manager.<action>), allowed or refused. Requires platform_admin.
Route: /v1/platform-manager/clusters/{cluster_id}/services/{service}/operations (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. clusterIDstringyes Identifier of the cluster in the Navin Manager. servicestringyes Name of the service. bodyanyyes The operation and its scope. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Request a service operation". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.Restores
Restores(ctx context.Context, opts ...CallOption) (json.RawMessage, error)
List the restore plans. Restore plans with their status and approval count (two approvers other than the requester). Requires platform_admin.
Route: /v1/platform-manager/backup/restores (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "List the restore plans". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.RevokeEnrollmentToken
RevokeEnrollmentToken(ctx context.Context, clusterID string, tokenID string, opts ...CallOption) (json.RawMessage, error)
Revoke an enrollment token. Revokes a bootstrap token of the node agent in the Manager (hosts:manage there) and answers 204; machines already enrolled are not affected. Audited (platform_manager.enrollment_token_revoke), allowed or refused. Requires platform_admin.
Route: /v1/platform-manager/clusters/{cluster_id}/enrollment-tokens/{token_id} (DELETE).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. clusterIDstringyes Identifier of the cluster in the Navin Manager. tokenIDstringyes Identifier of the enrollment token, as listed. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Revoke an enrollment token". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.RunPreflight
RunPreflight(ctx context.Context, hostID string, opts ...CallOption) (json.RawMessage, error)
Run the preflight checks. Runs the preflight checks of a machine (Manager operation host.preflight, hosts:manage there) and answers 202 with the operation id; read the results with GET .../preflight. Audited, allowed or refused. Requires platform_admin.
Route: /v1/platform-manager/hosts/{host_id}/preflight (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. hostIDstringyes Identifier of the machine in the Manager. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Run the preflight checks". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.SSHBootstrap
SSHBootstrap(ctx context.Context, clusterID string, body any, opts ...CallOption) (json.RawMessage, error)
Install the node agent over SSH. Installs the node agent on machines over SSH (Manager operation host.ssh_bootstrap, hosts:manage there) and answers 202 with the operation to follow. The private key is relayed to the Manager, which keeps it in memory for the bootstrap tasks only; the Control Plane never stores nor audits it (the audit keeps hosts, user, port, sudo and fingerprints). Requires platform_admin.
Route: /v1/platform-manager/clusters/{cluster_id}/hosts/ssh-bootstrap (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. clusterIDstringyes Identifier of the cluster in the Navin Manager. bodyanyyes Machines, SSH account and host key fingerprints. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Install the node agent over SSH". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.Service
Service(ctx context.Context, clusterID string, service string, opts ...CallOption) (json.RawMessage, error)
Get a service sheet. One service with its state fields and instance counts, its security state (TLS, number of secrets set out of the total) and the full sheet of the Manager. Requires platform_admin.
Route: /v1/platform-manager/clusters/{cluster_id}/services/{service} (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. clusterIDstringyes Identifier of the cluster in the Navin Manager. servicestringyes Name of the service. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Get a service sheet". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.ServiceConfig
ServiceConfig(ctx context.Context, clusterID string, service string, opts ...CallOption) (json.RawMessage, error)
Read the configuration of a service. Current configuration version of a service as the Manager shows it (secret values masked), with recommendations, groups and stale hosts. Needs configs:read in the Manager; editing stays in the Manager console. Requires platform_admin.
Route: /v1/platform-manager/clusters/{cluster_id}/services/{service}/config (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. clusterIDstringyes Identifier of the cluster in the Navin Manager. servicestringyes Name of the service. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Read the configuration of a service". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.ServiceConfigVersions
ServiceConfigVersions(ctx context.Context, clusterID string, service string, opts ...CallOption) (json.RawMessage, error)
List the configuration versions. Configuration version history of a service in the Manager (configs:read there). Requires platform_admin.
Route: /v1/platform-manager/clusters/{cluster_id}/services/{service}/config/versions (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. clusterIDstringyes Identifier of the cluster in the Navin Manager. servicestringyes Name of the service. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "List the configuration versions". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.Services
Services(ctx context.Context, clusterID string, opts ...CallOption) (json.RawMessage, error)
List the services of a cluster. Services of the cluster with the five state fields (desired, observed, health, operation, security), the administrative state and its reason, the running and total instance counts, drift (observed differs from desired), the delivery and the connection of a connected service. Requires platform_admin.
Route: /v1/platform-manager/clusters/{cluster_id}/services (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. clusterIDstringyes Identifier of the cluster in the Navin Manager. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "List the services of a cluster". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.SetMode
SetMode(ctx context.Context, clusterID string, service string, body any, opts ...CallOption) (json.RawMessage, error)
Set the operating mode of a service. Operating mode of a service (drain, scale to zero, security suspension, emergency stop, disable, quarantine, maintenance, enable), forwarded on behalf of the user; the Manager enforces the state it leaves behind and may require an approval. Audited (platform_manager.mode.<mode>) with the operation id and the resulting administrative state, allowed or refused. Requires platform_admin.
Route: /v1/platform-manager/clusters/{cluster_id}/services/{service}/mode (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. clusterIDstringyes Identifier of the cluster in the Navin Manager. servicestringyes Name of the service. bodyanyyes The mode to apply and its options. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Set the operating mode of a service". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.Setup
Setup(ctx context.Context, opts ...CallOption) (json.RawMessage, error)
Read the setup status. Getting started status, never a secret and never an error because the Manager is absent. core: API, PostgreSQL, migrations, Redis (optional) and Keycloak (optional), each with a state (ok, missing, down, error), the setting to fix and messages in English and French. manager: address and token reference set, credential found, Manager reachable, delegated user known, number of clusters, the suggested token reference and the permissions the Manager API token needs (changes need a restart). Requires platform_admin.
Route: /v1/platform-manager/setup (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Read the setup status". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.Summary
Summary(ctx context.Context, opts ...CallOption) (json.RawMessage, error)
Read the platform summary. Real counts per cluster (environment): services total, healthy, warning, failed; hosts; alerts; operations. Requires platform_admin.
Route: /v1/platform-manager/summary (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Read the platform summary". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.TestConnection
TestConnection(ctx context.Context, connectionID string, opts ...CallOption) (json.RawMessage, error)
Test a saved connection. Runs the protocol test of a saved connection now (its sealed secret stays in the Manager). Audited. Requires platform_admin.
Route: /v1/platform-manager/connections/{connection_id}/test (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. connectionIDstringyes Identifier of the connection in the Manager. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Test a saved connection". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.UpdateVaultEntry
UpdateVaultEntry(ctx context.Context, entryID string, body any, opts ...CallOption) (json.RawMessage, error)
Update a vault entry. Changes the given fields of a vault entry and seals them again (AES-256-GCM). A name used by another entry (case insensitive) answers 409 it_vault_name_taken; an empty name 422 validation_failed. Audited (it_vault.update, name and changed field names only). Requires platform_admin.
Route: /v1/platform-manager/vault/entries/{entry_id} (PATCH).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. entryIDstringyes Identifier (UUID) of the vault entry. bodyanyyes Fields to change. Unknown fields are refused. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Update a vault entry". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.ValidateConnect
ValidateConnect(ctx context.Context, clusterID string, body any, opts ...CallOption) (json.RawMessage, error)
Validate a service connection. Dry run of a connect by the Manager: answers ok, the errors (service, field, code, messages in both languages) and the health check result; nothing is stored. Requires platform_admin.
Route: /v1/platform-manager/clusters/{cluster_id}/services/connect/validate (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. clusterIDstringyes Identifier of the cluster in the Navin Manager. bodyanyyes The service to connect, as for the real connect. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Validate a service connection". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.ValidateConnection
ValidateConnection(ctx context.Context, body any, opts ...CallOption) (json.RawMessage, error)
Test a connection before saving it. Real protocol test of a connection before it is saved: answers ok, latency in milliseconds, server version, error code and messages; nothing is stored and the secret is never sent back. Audited without the secret. Requires platform_admin.
Route: /v1/platform-manager/connections/validate (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. bodyanyyes Type, parameters and secret of the connection to test. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Test a connection before saving it". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.ValidateInstall
ValidateInstall(ctx context.Context, clusterID string, body any, opts ...CallOption) (json.RawMessage, error)
Validate a services install. Dry run of an install by the Manager planner: answers ok, the errors (service, field, code, messages in both languages) and the plan it would run; nothing is installed. Requires platform_admin.
Route: /v1/platform-manager/clusters/{cluster_id}/services/validate (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. clusterIDstringyes Identifier of the cluster in the Navin Manager. bodyanyyes The install to check, as for the real install. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Validate a services install". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.VaultEntries
VaultEntries(ctx context.Context, opts ...CallOption) (json.RawMessage, error)
List the vault entries. Services of the IT vault by name, with URL, login, source (manual or installed:<service>) and whether a password and a key are set (has_password, has_api_key), never their values. Requires platform_admin.
Route: /v1/platform-manager/vault/entries (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "List the vault entries". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.VaultEntry
VaultEntry(ctx context.Context, entryID string, opts ...CallOption) (json.RawMessage, error)
Get a vault entry. One service of the vault without its password nor key (use POST .../reveal for them). Unknown id: 404 it_vault_entry_not_found. Requires platform_admin.
Route: /v1/platform-manager/vault/entries/{entry_id} (GET).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. entryIDstringyes Identifier (UUID) of the vault entry. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Get a vault entry". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.VaultReveal
VaultReveal(ctx context.Context, entryID string, opts ...CallOption) (json.RawMessage, error)
Reveal the secrets of a vault entry. Password and key of one service in clear (show and copy in the console). Each reveal is audited (it_vault.reveal) with the service name, never the values. Unknown id: 404 it_vault_entry_not_found. Requires platform_admin.
Route: /v1/platform-manager/vault/entries/{entry_id}/reveal (POST).
Name Type Default Required Description ctxcontext.Contextyes Context of the call: cancellation and deadline. entryIDstringyes Identifier (UUID) of the vault entry. opts...CallOptionno Per call options (query, idempotency key, traceparent, headers).
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Reveal the secrets of a vault entry". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).