Update Certificate

Update Certificate

Update an existing certificate or a chain of certificates (CAs) and, optionally, a private key that can be applied to the K8S Platform CA certificate. The certificate and the key should be stored in PEM format. If certificate is applied for Entity type NAPP_PLATFORM_CA, private key is mandatory.

Request
URI
PUT
https://api_host/napp/api/v1/platform/trust-management/certificates
COPY
Request Body
CertificateData of type(s) application/json
Optional
{
    "uuid": "string",
    "alias": "string",
    "pem_encoded": "string",
    "private_key": "string",
    "passphrase": "string",
    "used_by": "string",
    "details": {
        "ca_certificate_source": "string",
        "attributes": [
            {
                "subject_cn": "string",
                "issuer_cn": "string",
                "version": "string",
                "serial_number": "string",
                "signature_algorithm": "string",
                "signature": "string",
                "not_before": 0,
                "not_after": 0,
                "issuer": "string",
                "subject": "string",
                "public_key_algo": "string",
                "public_key_length": 0,
                "rsa_public_key_modulus": "string",
                "rsa_public_key_exponent": "string",
                "dsa_public_key_g": "string",
                "dsa_public_key_p": "string",
                "dsa_public_key_q": "string",
                "dsa_public_key_y": "string",
                "ecdsa_curve_name": "string",
                "ecdsa_ec_field": "string",
                "ecdsa_ec_field_f2mm": 0,
                "ecdsa_ec_field_f2mrp": "string",
                "ecdsa_ec_field_f2mks": [
                    0
                ],
                "ecdsa_ec_field_f2pp": "string",
                "ecdsa_public_key_a": "string",
                "ecdsa_public_key_b": "string",
                "ecdsa_public_key_seed": [
                    "string"
                ],
                "ecdsa_public_key_generator_x": "string",
                "ecdsa_public_key_generator_y": "string",
                "ecdsa_public_key_order": "string",
                "ecdsa_public_key_cofactor": 0,
                "is_ca": false,
                "is_valid": false
            }
        ]
    },
    "skip_sync_services": false
}
string
uuid
Optional

UUID of the certificate. Generated on k8s platform. If given in post request, the API will return bad request.

string
alias
Optional

Alias of the Certificate; Unique identifier of this certificate under a Certificate Entity.

string
pem_encoded
Optional

Pem encoded certificate data.

string
private_key
Optional

Private key data.

string
passphrase
Optional

Password for private key encryption.

used_by
Required

Type of Entity; for example a Service Type.

details
Optional

Certificate details

boolean
skip_sync_services
Optional

Skip synchronizing services after certificate change. User such as nsx-config can change multiple certificates without synchronizing services and synchronizes services in the last call.

Authentication
This operation uses the following authentication methods.
Responses
200

OK and Certificate content

Returns CertificateData of type(s) application/json
{
    "uuid": "string",
    "alias": "string",
    "pem_encoded": "string",
    "private_key": "string",
    "passphrase": "string",
    "used_by": "string",
    "details": {
        "ca_certificate_source": "string",
        "attributes": [
            {
                "subject_cn": "string",
                "issuer_cn": "string",
                "version": "string",
                "serial_number": "string",
                "signature_algorithm": "string",
                "signature": "string",
                "not_before": 0,
                "not_after": 0,
                "issuer": "string",
                "subject": "string",
                "public_key_algo": "string",
                "public_key_length": 0,
                "rsa_public_key_modulus": "string",
                "rsa_public_key_exponent": "string",
                "dsa_public_key_g": "string",
                "dsa_public_key_p": "string",
                "dsa_public_key_q": "string",
                "dsa_public_key_y": "string",
                "ecdsa_curve_name": "string",
                "ecdsa_ec_field": "string",
                "ecdsa_ec_field_f2mm": 0,
                "ecdsa_ec_field_f2mrp": "string",
                "ecdsa_ec_field_f2mks": [
                    0
                ],
                "ecdsa_ec_field_f2pp": "string",
                "ecdsa_public_key_a": "string",
                "ecdsa_public_key_b": "string",
                "ecdsa_public_key_seed": [
                    "string"
                ],
                "ecdsa_public_key_generator_x": "string",
                "ecdsa_public_key_generator_y": "string",
                "ecdsa_public_key_order": "string",
                "ecdsa_public_key_cofactor": 0,
                "is_ca": false,
                "is_valid": false
            }
        ]
    },
    "skip_sync_services": false
}
string
uuid
Optional

UUID of the certificate. Generated on k8s platform. If given in post request, the API will return bad request.

string
alias
Optional

Alias of the Certificate; Unique identifier of this certificate under a Certificate Entity.

string
pem_encoded
Optional

Pem encoded certificate data.

string
private_key
Optional

Private key data.

string
passphrase
Optional

Password for private key encryption.

used_by
Required

Type of Entity; for example a Service Type.

details
Optional

Certificate details

boolean
skip_sync_services
Optional

Skip synchronizing services after certificate change. User such as nsx-config can change multiple certificates without synchronizing services and synchronizes services in the last call.


400

Unknown backend error

Operation doesn't return any data structure