NAME

WWW::Hetzner::Storage::API::Subaccounts - Hetzner Storage Box Subaccounts API

VERSION

version 0.101

SYNOPSIS

my $subaccounts = $box->subaccounts;
my $subaccount = $subaccounts->create(
    home_directory => '/home/user',
    password       => 'secret',
);

DESCRIPTION

Manages subaccounts within one Storage Box.

list

my $subaccounts = $box->subaccounts->list(%query);

Returns an arrayref of WWW::Hetzner::Storage::Subaccount objects. The API accepts name, label_selector, sort, and username filters.

get

my $subaccount = $box->subaccounts->get($id);

Returns a WWW::Hetzner::Storage::Subaccount.

create

my $subaccount = $box->subaccounts->create(%params);

Creates a subaccount. home_directory and password are required. Returns a Subaccount with its creation action.

update

my $subaccount = $box->subaccounts->update($id, %params);

Updates a subaccount's name, description, and/or labels. Returns the updated Subaccount without an action.

delete

my $action = $box->subaccounts->delete($id);

Deletes a subaccount and returns its action.

change_home_directory

my $action = $box->subaccounts->change_home_directory(
    $id, home_directory => '/home/new-user',
);

Changes a subaccount's home directory and returns its action.

reset_subaccount_password

my $action = $box->subaccounts->reset_subaccount_password(
    $id, password => 'secret',
);

Resets a subaccount password and returns its action.

update_access_settings

my $action = $box->subaccounts->update_access_settings($id, %settings);

Updates subaccount access settings and returns its action.

SEE ALSO

SUPPORT

Issues

Please report bugs and feature requests on GitHub at https://github.com/Getty/p5-www-hetzner/issues.

IRC

Join #kubernetes on irc.perl.org or message Getty directly.

CONTRIBUTING

Contributions are welcome! Please fork the repository and submit a pull request.

AUTHOR

Torsten Raudssus <torsten@raudssus.de>

COPYRIGHT AND LICENSE

This software is copyright (c) 2026 by Torsten Raudssus <torsten@raudssus.de> https://raudssus.de/.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.