Class: Certificate

Last published : Oct 01, 2026
An X509 certificate used for TLS connections
Related information
XenServer 9 Management API

Fields for class: Certificate

Field Type Qualifier Description
fingerprint string RO/constructor Deprecated. Use fingerprint_sha256 instead
fingerprint_sha1 string RO/constructor The certificate's SHA1 fingerprint / hash
fingerprint_sha256 string RO/constructor The certificate's SHA256 fingerprint / hash
host host ref RO/constructor The host where the certificate is installed
name string RO/runtime The name of the certificate, only present on certificates of type 'ca'
not_after datetime RO/constructor Date before which the certificate is valid
not_before datetime RO/constructor Date after which the certificate is valid
purpose certificate_purpose set RO/constructor The purposes of the certificate
type certificate_type RO/runtime The type of the certificate, either 'ca', 'host' or 'host_internal'
uuid string RO/runtime Unique identifier/object reference

RPCs associated with class: Certificate

RPC name: getall

Overview:
Return a list of all the Certificates known to the system.
Signature:
Certificate ref set get_all (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: Certificate ref set
references to all objects

RPC name: getallrecords

Overview:
Return a map of Certificate references to Certificate records for all Certificates known to the system.
Signature:
(Certificate ref -> Certificate record) map get_all_records (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: (Certificate ref -> Certificate record) map
records of all objects

RPC name: getbyuuid

Overview:
Get a reference to the Certificate instance with the specified UUID.
Signature:
Certificate ref get_by_uuid (session ref session_ref, string uuid)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
string uuid UUID of object to return
Minimum Role: read-only
Return Type: Certificate ref
reference to the object

RPC name: getfingerprint

This message is deprecated.
Overview:
Get the fingerprint field of the given Certificate.
Signature:
string get_fingerprint (session ref session_ref, Certificate ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Certificate ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getfingerprintsha1

Overview:
Get the fingerprintsha1 field of the given Certificate.
Signature:
string get_fingerprint_sha1 (session ref session_ref, Certificate ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Certificate ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getfingerprintsha256

Overview:
Get the fingerprintsha256 field of the given Certificate.
Signature:
string get_fingerprint_sha256 (session ref session_ref, Certificate ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Certificate ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: gethost

Overview:
Get the host field of the given Certificate.
Signature:
host ref get_host (session ref session_ref, Certificate ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Certificate ref self reference to the object
Minimum Role: read-only
Return Type: host ref
value of the field

RPC name: getname

Overview:
Get the name field of the given Certificate.
Signature:
string get_name (session ref session_ref, Certificate ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Certificate ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getnotafter

Overview:
Get the notafter field of the given Certificate.
Signature:
datetime get_not_after (session ref session_ref, Certificate ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Certificate ref self reference to the object
Minimum Role: read-only
Return Type: datetime
value of the field

RPC name: getnotbefore

Overview:
Get the notbefore field of the given Certificate.
Signature:
datetime get_not_before (session ref session_ref, Certificate ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Certificate ref self reference to the object
Minimum Role: read-only
Return Type: datetime
value of the field

RPC name: getpurpose

Overview:
Get the purpose field of the given Certificate.
Signature:
certificate_purpose set get_purpose (session ref session_ref, Certificate ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Certificate ref self reference to the object
Minimum Role: read-only
Return Type: certificate_purpose set
value of the field

RPC name: getrecord

Overview:
Get a record containing the current state of the given Certificate.
Signature:
Certificate record get_record (session ref session_ref, Certificate ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Certificate ref self reference to the object
Minimum Role: read-only
Return Type: Certificate record
all fields from the object

RPC name: gettype

Overview:
Get the type field of the given Certificate.
Signature:
certificate_type get_type (session ref session_ref, Certificate ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Certificate ref self reference to the object
Minimum Role: read-only
Return Type: certificate_type
value of the field

RPC name: getuuid

Overview:
Get the uuid field of the given Certificate.
Signature:
string get_uuid (session ref session_ref, Certificate ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Certificate ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field