Skip to main content
POST
Create a Proxmox VE credential

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required
api_url
string
required

The Proxmox VE API URL, e.g. https://pve.example.com:8006.

token_id
string
required

The API token ID, e.g. ankra@pve!platform.

token_secret
string
required

The API token secret. Stored in Vault, never returned.

internal_api_url
string

An API URL the platform uses from inside the estate, when it differs from api_url.

tls_insecure
boolean
default:false

Skip TLS verification of the API (self-signed certificates).

jumphost
object | null

An SSH jump host the platform reaches the API and the VMs through.

tailscale
object | null

Tailscale (or Headscale) settings the cluster VMs join with, the way the platform reaches VMs on a node-local SDN.

Response

Credential created

errors
object[]
required
success
boolean
required
id
string<uuid>

The created credential's id.

name
string

The created credential's name.