NAME

OpenXPKI::Server::API2::Plugin::Datapool::delete_data_pool_entry

COMMANDS

delete_data_pool_entry

Delete an entry, specified by namespace and key, from the datapool. The command does not check if the entry exists at all and always returns true.

Side effect: this method automatically wipes all data pool entries whose expiration date has passed.

Example:

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

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