/ 
Cloudflare-API-1.010
/ Cloudflare::API::SecretsStore

NAME

Cloudflare::API::SecretsStore - manage Cloudflare Secrets Store resources

SYNOPSIS

my $store=$api->secrets_store();
my $stores=$store->list_stores();
my $secret=$store->create_secret($store_id, [{
    name   => 'API_KEY',
    value  => $secret_value,
    scopes => ['workers']
}]);

DESCRIPTION

These account-scoped methods manage stores, secret metadata, write-only secret values, and quota. Cloudflare does not return a secret's value through get_secret(). Keep values out of logs, command lines, and source control.

METHODS

  • list_stores(%query) — List stores with named query filters. Returns result; full_response => 1 retains pagination information.

  • get_store($id, %options) — Retrieve a store by ID and return its result.

  • create_store(\%body, %options) — POST a store definition and return its result.

  • delete_store($id, %options) — DELETE a store and return the endpoint's result, possibly undef for an empty body.

  • list_secrets($store_id, %query) — List secrets in one store with named query filters. Returns metadata in result; full_response => 1 retains pagination information.

  • get_secret($store_id, $secret_id, %options) — Return one secret's metadata in result; its value is not available.

  • create_secret($store_id, \@secrets, %options) — POST a non-empty array reference, even when creating one secret. Each entry should supply name, value, and scopes such as ['workers']; comment is optional. Returns result.

  • update_secret($store_id, $secret_id, \%body, %options) — PATCH a secret with fields such as value, scopes, or comment. Returns result.

  • delete_secret($store_id, $secret_id, %options) — DELETE a secret and return the endpoint's result, possibly undef for an empty body.

  • get_quota(%options) — Retrieve the account's Secrets Store usage and return result.

Every JSON method accepts full_response => 1 for the decoded envelope. IDs are percent-encoded as path components. Create-store and update-secret bodies must be hash references; create_secret() requires a non-empty array reference. The module passes accepted field details through to Cloudflare.

ERRORS

Missing account context, invalid identifiers or body shapes, HTTP and transport failures, and Cloudflare envelope failures cause exceptions as described in Cloudflare::API.

SEE ALSO

Cloudflare::API, Cloudflare::API::Workers

AUTHOR

Andrew Speer mailto:andrew.speer@isolutions.com.au

LICENSE and COPYRIGHT

Copyright (c) 2026 Andrew Speer. This software is free software under the same terms as Perl 5.