1. Registry
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. getCertificate
Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 by akeyless-community
akeyless
Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 by akeyless-community

    Certificate data source

    Using getCertificate

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCertificate(args: GetCertificateArgs, opts?: InvokeOptions): Promise<GetCertificateResult>
    function getCertificateOutput(args: GetCertificateOutputArgs, opts?: InvokeOutputOptions): Output<GetCertificateResult>
    def get_certificate(format: Optional[str] = None,
                        id: Optional[str] = None,
                        ignore_cache: Optional[str] = None,
                        include_private_key: Optional[bool] = None,
                        leaf_only: Optional[bool] = None,
                        name: Optional[str] = None,
                        password: Optional[str] = None,
                        version: Optional[float] = None,
                        opts: Optional[InvokeOptions] = None) -> GetCertificateResult
    def get_certificate_output(format: pulumi.Input[Optional[str]] = None,
                        id: pulumi.Input[Optional[str]] = None,
                        ignore_cache: pulumi.Input[Optional[str]] = None,
                        include_private_key: pulumi.Input[Optional[bool]] = None,
                        leaf_only: pulumi.Input[Optional[bool]] = None,
                        name: pulumi.Input[Optional[str]] = None,
                        password: pulumi.Input[Optional[str]] = None,
                        version: pulumi.Input[Optional[float]] = None,
                        opts: Optional[InvokeOutputOptions] = None) -> Output[GetCertificateResult]
    func LookupCertificate(ctx *Context, args *LookupCertificateArgs, opts ...InvokeOption) (*LookupCertificateResult, error)
    func LookupCertificateOutput(ctx *Context, args *LookupCertificateOutputArgs, opts ...InvokeOption) LookupCertificateResultOutput

    > Note: This function is named LookupCertificate in the Go SDK.

    public static class GetCertificate 
    {
        public static Task<GetCertificateResult> InvokeAsync(GetCertificateArgs args, InvokeOptions? opts = null)
        public static Output<GetCertificateResult> Invoke(GetCertificateInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetCertificateResult> Invoke(GetCertificateInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetCertificateResult> getCertificate(GetCertificateArgs args, InvokeOptions options)
    public static Output<GetCertificateResult> getCertificate(GetCertificateArgs args, InvokeOptions options)
    public static Output<GetCertificateResult> getCertificate(GetCertificateArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: akeyless:index/getCertificate:getCertificate
      arguments:
        # arguments dictionary
    data "akeyless_get_certificate" "name" {
        # arguments
    }

    The following arguments are supported:

    Format string
    Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
    Id string
    The ID of this resource.
    IgnoreCache string
    Retrieve the Secret value without checking the Gateway's cache [true/false]
    IncludePrivateKey bool
    If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
    LeafOnly bool
    If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
    Name string
    Certificate name
    Password string
    Password to protect the pfx/jks file, required when format is pfx or jks
    Version double
    Certificate version
    Format string
    Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
    Id string
    The ID of this resource.
    IgnoreCache string
    Retrieve the Secret value without checking the Gateway's cache [true/false]
    IncludePrivateKey bool
    If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
    LeafOnly bool
    If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
    Name string
    Certificate name
    Password string
    Password to protect the pfx/jks file, required when format is pfx or jks
    Version float64
    Certificate version
    format string
    Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
    id string
    The ID of this resource.
    ignore_cache string
    Retrieve the Secret value without checking the Gateway's cache [true/false]
    include_private_key bool
    If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
    leaf_only bool
    If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
    name string
    Certificate name
    password string
    Password to protect the pfx/jks file, required when format is pfx or jks
    version number
    Certificate version
    format String
    Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
    id String
    The ID of this resource.
    ignoreCache String
    Retrieve the Secret value without checking the Gateway's cache [true/false]
    includePrivateKey Boolean
    If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
    leafOnly Boolean
    If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
    name String
    Certificate name
    password String
    Password to protect the pfx/jks file, required when format is pfx or jks
    version Double
    Certificate version
    format string
    Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
    id string
    The ID of this resource.
    ignoreCache string
    Retrieve the Secret value without checking the Gateway's cache [true/false]
    includePrivateKey boolean
    If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
    leafOnly boolean
    If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
    name string
    Certificate name
    password string
    Password to protect the pfx/jks file, required when format is pfx or jks
    version number
    Certificate version
    format str
    Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
    id str
    The ID of this resource.
    ignore_cache str
    Retrieve the Secret value without checking the Gateway's cache [true/false]
    include_private_key bool
    If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
    leaf_only bool
    If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
    name str
    Certificate name
    password str
    Password to protect the pfx/jks file, required when format is pfx or jks
    version float
    Certificate version
    format String
    Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
    id String
    The ID of this resource.
    ignoreCache String
    Retrieve the Secret value without checking the Gateway's cache [true/false]
    includePrivateKey Boolean
    If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
    leafOnly Boolean
    If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
    name String
    Certificate name
    password String
    Password to protect the pfx/jks file, required when format is pfx or jks
    version Number
    Certificate version

    getCertificate Result

    The following output properties are available:

    CertificatePem string
    The certificate value in pem format
    EncodedCertificate string
    Base64-encoded certificate data, returned when format is pfx or jks
    Id string
    The ID of this resource.
    PrivateKeyPem string
    The private key value in pem format
    Format string
    Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
    IgnoreCache string
    Retrieve the Secret value without checking the Gateway's cache [true/false]
    IncludePrivateKey bool
    If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
    LeafOnly bool
    If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
    Name string
    Certificate name
    Password string
    Password to protect the pfx/jks file, required when format is pfx or jks
    Version double
    Certificate version
    CertificatePem string
    The certificate value in pem format
    EncodedCertificate string
    Base64-encoded certificate data, returned when format is pfx or jks
    Id string
    The ID of this resource.
    PrivateKeyPem string
    The private key value in pem format
    Format string
    Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
    IgnoreCache string
    Retrieve the Secret value without checking the Gateway's cache [true/false]
    IncludePrivateKey bool
    If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
    LeafOnly bool
    If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
    Name string
    Certificate name
    Password string
    Password to protect the pfx/jks file, required when format is pfx or jks
    Version float64
    Certificate version
    certificate_pem string
    The certificate value in pem format
    encoded_certificate string
    Base64-encoded certificate data, returned when format is pfx or jks
    id string
    The ID of this resource.
    private_key_pem string
    The private key value in pem format
    format string
    Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
    ignore_cache string
    Retrieve the Secret value without checking the Gateway's cache [true/false]
    include_private_key bool
    If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
    leaf_only bool
    If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
    name string
    Certificate name
    password string
    Password to protect the pfx/jks file, required when format is pfx or jks
    version number
    Certificate version
    certificatePem String
    The certificate value in pem format
    encodedCertificate String
    Base64-encoded certificate data, returned when format is pfx or jks
    id String
    The ID of this resource.
    privateKeyPem String
    The private key value in pem format
    format String
    Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
    ignoreCache String
    Retrieve the Secret value without checking the Gateway's cache [true/false]
    includePrivateKey Boolean
    If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
    leafOnly Boolean
    If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
    name String
    Certificate name
    password String
    Password to protect the pfx/jks file, required when format is pfx or jks
    version Double
    Certificate version
    certificatePem string
    The certificate value in pem format
    encodedCertificate string
    Base64-encoded certificate data, returned when format is pfx or jks
    id string
    The ID of this resource.
    privateKeyPem string
    The private key value in pem format
    format string
    Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
    ignoreCache string
    Retrieve the Secret value without checking the Gateway's cache [true/false]
    includePrivateKey boolean
    If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
    leafOnly boolean
    If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
    name string
    Certificate name
    password string
    Password to protect the pfx/jks file, required when format is pfx or jks
    version number
    Certificate version
    certificate_pem str
    The certificate value in pem format
    encoded_certificate str
    Base64-encoded certificate data, returned when format is pfx or jks
    id str
    The ID of this resource.
    private_key_pem str
    The private key value in pem format
    format str
    Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
    ignore_cache str
    Retrieve the Secret value without checking the Gateway's cache [true/false]
    include_private_key bool
    If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
    leaf_only bool
    If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
    name str
    Certificate name
    password str
    Password to protect the pfx/jks file, required when format is pfx or jks
    version float
    Certificate version
    certificatePem String
    The certificate value in pem format
    encodedCertificate String
    Base64-encoded certificate data, returned when format is pfx or jks
    id String
    The ID of this resource.
    privateKeyPem String
    The private key value in pem format
    format String
    Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
    ignoreCache String
    Retrieve the Secret value without checking the Gateway's cache [true/false]
    includePrivateKey Boolean
    If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
    leafOnly Boolean
    If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
    name String
    Certificate name
    password String
    Password to protect the pfx/jks file, required when format is pfx or jks
    version Number
    Certificate version

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless
    Viewing docs for akeyless 2.1.0
    published on Thursday, Nov 19, 2026 by akeyless-community

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial