GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
OpenXPKI::Server::API2::Plugin::Datapool::get_data_pool_entry(3) User Contributed Perl Documentation OpenXPKI::Server::API2::Plugin::Datapool::get_data_pool_entry(3)

OpenXPKI::Server::API2::Plugin::Datapool::get_data_pool_entry

Searches the specified key in the datapool and returns a HashRef.

    my $info = CTX('api2')->get_data_pool_entry(
        pki_realm => $pki_realm,
        namespace => 'workflow.foo.bar',
        key => 'myvariable',
    );

Returns:

    {
        pki_realm       => '...',   # PKI realm
        namespace       => '...',   # namespace
        key             => '...',   # data pool key
        value           => '...',   # value
        encrypted       => 1,       # 1 or 0, depending on if it was encrypted
        encryption_key  => '...',   # encryption key id used (may not be available)
        mtime           => 12345,   # date of last modification (epoch)
        expiration_date => 12356,   # date of expiration (epoch)
    }

Returns undef if no item is found.

Parameters

  • "pki_realm" Str - PKI realm. Optional, default: current realm

    If the API is called directly from OpenXPKI::Server::Workflow only the PKI realm of the currently active session is accepted.

  • "namespace" Str - datapool namespace (custom string to organize entries)
  • "key" Str - entry key
  • "decrypt" Bool - set to 0 to skip decryption of encrypted items
2022-05-14 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.