Skip to main content

crypto_certificatekeypairs_update

PUT 
/api/v3//crypto/certificatekeypairs/:kp_uuid/

CertificateKeyPair Viewset

Request​

Path Parameters

    kp_uuid uuidrequired

    A UUID string identifying this Certificate-Key Pair.

Bodyrequired

    namestringrequired

    Possible values: non-empty

    certificate_datastringrequired

    PEM-encoded Certificate data

    Possible values: non-empty

    key_datastring

    Optional Private Key. If this is set, you can use this keypair for encryption.

Responses​

Schema
    pkuuidrequired
    namestringrequired
    fingerprint_sha256stringnullablerequired

    Get certificate Hash (SHA256)

    fingerprint_sha1stringnullablerequired

    Get certificate Hash (SHA1)

    cert_expirydate-timenullablerequired

    Get certificate expiry

    cert_subjectstringnullablerequired

    Get certificate subject as full rfc4514

    private_key_availablebooleanrequired

    Show if this keypair has a private key configured or not

    private_key_typestringnullablerequired

    Get the private key's type, if set

    certificate_download_urlstringrequired

    Get URL to download certificate

    private_key_download_urlstringrequired

    Get URL to download private key

    managedManaged by authentik (string)nullablerequired

    Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.

Authorization: http

name: authentiktype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "/api/v3/crypto/certificatekeypairs/:kp_uuid/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"name\": \"string\",\n  \"certificate_data\": \"string\",\n  \"key_data\": \"string\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
/api/v3
Auth
Parameters
— pathrequired
Body required
{
  "name": "string",
  "certificate_data": "string",
  "key_data": "string"
}