Update SSL TLS key type

This function sets a user’s preferred SSL/TLS key type.

Authorizations:
query Parameters
type
required
string

The key type to set.

  • system — Use the system’s ssl_default_key_type value.
  • rsa-2048 — 2,048-bit RSA.
  • rsa-4096 — 4,096-bit RSA.
  • ecdsa-prime256v1 — ECDSA prime256v1 (“P-256”).
  • ecdsa-secp384r1 — ECDSA secp384r1 (“P-384”).
Enum: "system" "rsa-2048" "rsa-4096" "ecdsa-prime256v1" "ecdsa-secp384r1"
Example: type=ecdsa-prime256v1

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --user=username SSL set_default_key_type type='ecdsa-prime256v1'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "set_default_key_type",
  • "module": "SSL",
  • "result": {
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}