GET /config/certificates/end_certificates/{id}/full_chain

Edit online

Gets the full chain of the certificate. The chain hierarchy includes the content of the end certificate, and the content of the issuer chain certificates, up to and including the root certificate. This endpoint might not return the root certificate if it was uploaded in the last 24 hours.

Gets the full chain of the certificate.

You must have System Administrator, Security Administrator, Manage Log Sources, or WinCollect permissions to use this endpoint.

Table 1. GET /config/certificates/end_certificates/{id}/full_chain resource details
MIME Type
application/json

Table 2. GET /config/certificates/end_certificates/{id}/full_chain request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
id	path	Required	Number (Integer)	text/plain	Required. The ID of the certificate whose full chain is required.
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. GET /config/certificates/end_certificates/{id}/full_chain response codes
HTTP Response Code	Unique Code	Description
404	1002	No certificate exists with this ID.
422	1103	null
422	1104	null
500	1020	null
500	2035	null

Response Description

A JSON object that contains the chain hierarchy, from the end certificate up to the root certificate. The JSON object contains each certificate's original contents.

id - The root certificate's resource ID.

Response Sample


{
    "end_certificate": {
        "ca_chain_file": "String",
        "cert_file": "String",
        "certificate_revocation_list_distribution_point": "String",
        "component_id": 42,
        "component_name": "String",
        "csr_id": 42,
        "expiry": 42,
        "extended_key_usage": [
            "String <one of: TLS_Web_server_authentication, TLS_Web_client_authentication, Email_protection>"
        ],
        "id": 42,
        "issuer": [
            {
                "field_name": "String",
                "value": "String"
            }
        ],
        "key_file": "String",
        "key_password": "String",
        "key_usage": [
            "String <one of: CRL_SIGN, DATA_ENCIPHERMENT, DECIPHER_ONLY, DIGITAL_SIGNATURE, ENCIPHER_ONLY, KEY_AGREEMENT, KEY_CERT_SIGN, KEY_ENCIPHERMENT, NON_REPUDIATION>"
        ],
        "name": "String",
        "not_before": 42,
        "purpose": "String",
        "serial_number": "String",
        "status": "String",
        "subject": [
            {
                "field_name": "String",
                "value": "String"
            }
        ],
        "validation": 42
    },
    "intermediate_chain": [
        {
            "certificate_revocation_list_distribution_point": "String",
            "expiry": 42,
            "issuer": [
                {
                    "field_name": "String",
                    "value": "String"
                }
            ],
            "key_usage": [
                "String <one of: CRL_SIGN, DATA_ENCIPHERMENT, DECIPHER_ONLY, DIGITAL_SIGNATURE, ENCIPHER_ONLY, KEY_AGREEMENT, KEY_CERT_SIGN, KEY_ENCIPHERMENT, NON_REPUDIATION>"
            ],
            "not_before": 42,
            "serial_number": "String",
            "status": "String",
            "subject": [
                {
                    "field_name": "String",
                    "value": "String"
                }
            ],
            "validation": 42
        }
    ],
    "root_certificate": {
        "authority_key_id": "String",
        "expiry": 42,
        "id": "String",
        "issuer": [
            {
                "field_name": "String",
                "value": "String"
            }
        ],
        "key_usage": [
            "String <one of: CRL_SIGN, DATA_ENCIPHERMENT, DECIPHER_ONLY, DIGITAL_SIGNATURE, ENCIPHER_ONLY, KEY_AGREEMENT, KEY_CERT_SIGN, KEY_ENCIPHERMENT, NON_REPUDIATION>"
        ],
        "not_before": 42,
        "serial_number": "String",
        "status": "String",
        "subject": [
            {
                "field_name": "String",
                "value": "String"
            }
        ],
        "subject_key_id": "String",
        "validation": 42
    }
}