Hostinger\HostingDatabasesApi

All URIs are relative to https://developers.hostinger.com, except if the operation defines another base path.

Method	HTTP request	Description
changeDatabasePasswordV1()	PATCH /api/hosting/v1/accounts/{username}/databases/{name}/change-password	Change database password
createAccountDatabaseRemoteConnectionV1()	POST /api/hosting/v1/accounts/{username}/databases/{name}/remote-connections	Create account database remote connection
createAccountDatabaseV1()	POST /api/hosting/v1/accounts/{username}/databases	Create account database
deleteAccountDatabaseRemoteConnectionV1()	DELETE /api/hosting/v1/accounts/{username}/databases/{name}/remote-connections	Delete account database remote connection
deleteAccountDatabaseV1()	DELETE /api/hosting/v1/accounts/{username}/databases/{name}	Delete account database
getPhpMyAdminLinkV1()	GET /api/hosting/v1/accounts/{username}/databases/{name}/phpmyadmin-link	Get phpMyAdmin link
listAccountDatabaseRemoteConnectionsV1()	GET /api/hosting/v1/accounts/{username}/databases/remote-connections	List account database remote connections
listAccountDatabasesV1()	GET /api/hosting/v1/accounts/{username}/databases	List account databases
repairDatabaseV1()	PATCH /api/hosting/v1/accounts/{username}/databases/{name}/repair	Repair database

`changeDatabasePasswordV1()`

changeDatabasePasswordV1($username, $name, $hostingV1DatabasesChangeDatabasePasswordRequest): \Hostinger\Model\CommonSuccessEmptyResource

Change database password

Changes the password for the specified database user. The database name must be the full name returned by the list databases endpoint. The password must also be updated in any website configuration that uses this database.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\HostingDatabasesApi(config: $config);
$username = u123456789; // string
$name = u123456789_test_db; // string | Full database name as returned by the list databases endpoint.
$hostingV1DatabasesChangeDatabasePasswordRequest = new \Hostinger\Model\HostingV1DatabasesChangeDatabasePasswordRequest(); // \Hostinger\Model\HostingV1DatabasesChangeDatabasePasswordRequest

try {
    $result = $apiInstance->changeDatabasePasswordV1($username, $name, $hostingV1DatabasesChangeDatabasePasswordRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostingDatabasesApi->changeDatabasePasswordV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
username	string
name	string	Full database name as returned by the list databases endpoint.
hostingV1DatabasesChangeDatabasePasswordRequest	\Hostinger\Model\HostingV1DatabasesChangeDatabasePasswordRequest

Return type

\Hostinger\Model\CommonSuccessEmptyResource

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`createAccountDatabaseRemoteConnectionV1()`

createAccountDatabaseRemoteConnectionV1($username, $name, $hostingV1DatabasesRemoteConnectionsCreateRemoteConnectionRequest): \Hostinger\Model\CommonSuccessEmptyResource

Create account database remote connection

Allows a remote host to connect to the specified database. Provide an IPv4/IPv6 address, or "%" to allow any host. The database name must be the full name returned by the list databases endpoint.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\HostingDatabasesApi(config: $config);
$username = u123456789; // string
$name = u123456789_test_db; // string | Full database name as returned by the list databases endpoint.
$hostingV1DatabasesRemoteConnectionsCreateRemoteConnectionRequest = new \Hostinger\Model\HostingV1DatabasesRemoteConnectionsCreateRemoteConnectionRequest(); // \Hostinger\Model\HostingV1DatabasesRemoteConnectionsCreateRemoteConnectionRequest

try {
    $result = $apiInstance->createAccountDatabaseRemoteConnectionV1($username, $name, $hostingV1DatabasesRemoteConnectionsCreateRemoteConnectionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostingDatabasesApi->createAccountDatabaseRemoteConnectionV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
username	string
name	string	Full database name as returned by the list databases endpoint.
hostingV1DatabasesRemoteConnectionsCreateRemoteConnectionRequest	\Hostinger\Model\HostingV1DatabasesRemoteConnectionsCreateRemoteConnectionRequest

Return type

\Hostinger\Model\CommonSuccessEmptyResource

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`createAccountDatabaseV1()`

createAccountDatabaseV1($username, $hostingV1DatabasesCreateDatabaseRequest): \Hostinger\Model\CommonSuccessEmptyResource

Create account database

Creates a database with a database user and password for the specified account. The database name and user are automatically prefixed with the account username when needed.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\HostingDatabasesApi(config: $config);
$username = u123456789; // string
$hostingV1DatabasesCreateDatabaseRequest = new \Hostinger\Model\HostingV1DatabasesCreateDatabaseRequest(); // \Hostinger\Model\HostingV1DatabasesCreateDatabaseRequest

try {
    $result = $apiInstance->createAccountDatabaseV1($username, $hostingV1DatabasesCreateDatabaseRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostingDatabasesApi->createAccountDatabaseV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
username	string
hostingV1DatabasesCreateDatabaseRequest	\Hostinger\Model\HostingV1DatabasesCreateDatabaseRequest

Return type

\Hostinger\Model\CommonSuccessEmptyResource

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteAccountDatabaseRemoteConnectionV1()`

deleteAccountDatabaseRemoteConnectionV1($username, $name, $ip): \Hostinger\Model\CommonSuccessEmptyResource

Delete account database remote connection

Permanently removes a remote-access rule, revoking the given host's remote access to the database. Identify the rule with the required ip query parameter (the IPv4/IPv6 address, or "%", exactly as returned by the list remote connections endpoint). The database name must be the full name returned by the list databases endpoint.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\HostingDatabasesApi(config: $config);
$username = u123456789; // string
$name = u123456789_test_db; // string | Full database name as returned by the list databases endpoint.
$ip = 192.0.2.10; // string | Remote host to revoke: the IPv4/IPv6 address, or \"%\", exactly as returned by the list remote connections endpoint.

try {
    $result = $apiInstance->deleteAccountDatabaseRemoteConnectionV1($username, $name, $ip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostingDatabasesApi->deleteAccountDatabaseRemoteConnectionV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
username	string
name	string	Full database name as returned by the list databases endpoint.
ip	string	Remote host to revoke: the IPv4/IPv6 address, or "%", exactly as returned by the list remote connections endpoint.

Return type

\Hostinger\Model\CommonSuccessEmptyResource

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteAccountDatabaseV1()`

deleteAccountDatabaseV1($username, $name): \Hostinger\Model\CommonSuccessEmptyResource

Delete account database

Permanently deletes a database and its remote connections. The database name must be the full name returned by the list databases endpoint.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\HostingDatabasesApi(config: $config);
$username = u123456789; // string
$name = u123456789_test_db; // string | Full database name as returned by the list databases endpoint.

try {
    $result = $apiInstance->deleteAccountDatabaseV1($username, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostingDatabasesApi->deleteAccountDatabaseV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
username	string
name	string	Full database name as returned by the list databases endpoint.

Return type

\Hostinger\Model\CommonSuccessEmptyResource

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getPhpMyAdminLinkV1()`

getPhpMyAdminLinkV1($username, $name): \Hostinger\Model\HostingV1DatabasesPhpMyAdminLinkResource

Get phpMyAdmin link

Returns a direct sign-on link to phpMyAdmin for the specified database. Use this when a visual database interface is needed for SQL queries, imports, exports, or table management. The database name must be the full name returned by the list databases endpoint.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\HostingDatabasesApi(config: $config);
$username = u123456789; // string
$name = u123456789_test_db; // string | Full database name as returned by the list databases endpoint.

try {
    $result = $apiInstance->getPhpMyAdminLinkV1($username, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostingDatabasesApi->getPhpMyAdminLinkV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
username	string
name	string	Full database name as returned by the list databases endpoint.

Return type

\Hostinger\Model\HostingV1DatabasesPhpMyAdminLinkResource

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listAccountDatabaseRemoteConnectionsV1()`

listAccountDatabaseRemoteConnectionsV1($username, $domain): \Hostinger\Model\HostingV1DatabasesRemoteConnectionsRemoteConnectionResource[]

List account database remote connections

Returns the remote-access rules for the specified account: the remote hosts (IPv4/IPv6 addresses, or "%" for any host) allowed to connect to the account databases. Use the domain filter to only return rules for databases assigned to a specific domain.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\HostingDatabasesApi(config: $config);
$username = u123456789; // string
$domain = example.com; // string | Filter remote connections by the domain the database is assigned to. Rules for databases not assigned to any domain are always included.

try {
    $result = $apiInstance->listAccountDatabaseRemoteConnectionsV1($username, $domain);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostingDatabasesApi->listAccountDatabaseRemoteConnectionsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
username	string
domain	string	Filter remote connections by the domain the database is assigned to. Rules for databases not assigned to any domain are always included.	[optional]

Return type

\Hostinger\Model\HostingV1DatabasesRemoteConnectionsRemoteConnectionResource[]

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listAccountDatabasesV1()`

listAccountDatabasesV1($username, $page, $perPage, $domain, $isAssigned, $search): \Hostinger\Model\HostingListAccountDatabasesV1200Response

List account databases

Returns a paginated list of databases for the specified account. Use the domain and is_assigned filters to find databases assigned to a specific domain.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\HostingDatabasesApi(config: $config);
$username = u123456789; // string
$page = 1; // int | Page number
$perPage = 25; // int | Number of items per page
$domain = example.com; // string | Filter by domain name (exact match)
$isAssigned = true; // bool | When used with domain, return only databases assigned to that domain.
$search = test_db; // string | Search databases by name, user, or creation date.

try {
    $result = $apiInstance->listAccountDatabasesV1($username, $page, $perPage, $domain, $isAssigned, $search);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostingDatabasesApi->listAccountDatabasesV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
username	string
page	int	Page number	[optional]
perPage	int	Number of items per page	[optional] [default to 25]
domain	string	Filter by domain name (exact match)	[optional]
isAssigned	bool	When used with domain, return only databases assigned to that domain.	[optional]
search	string	Search databases by name, user, or creation date.	[optional]

Return type

\Hostinger\Model\HostingListAccountDatabasesV1200Response

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`repairDatabaseV1()`

repairDatabaseV1($username, $name): \Hostinger\Model\CommonSuccessEmptyResource

Repair database

Repairs corrupted database tables asynchronously. Use when database errors, crashes, or corruption are reported. The database name must be the full name returned by the list databases endpoint.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\HostingDatabasesApi(config: $config);
$username = u123456789; // string
$name = u123456789_test_db; // string | Full database name as returned by the list databases endpoint.

try {
    $result = $apiInstance->repairDatabaseV1($username, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostingDatabasesApi->repairDatabaseV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
username	string
name	string	Full database name as returned by the list databases endpoint.

Return type

\Hostinger\Model\CommonSuccessEmptyResource

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Uh oh!

FilesExpand file tree

HostingDatabasesApi.md

Latest commit

History

HostingDatabasesApi.md

File metadata and controls

Hostinger\HostingDatabasesApi

changeDatabasePasswordV1()

Example

Parameters

Return type

createAccountDatabaseRemoteConnectionV1()

Example

Parameters

Return type

createAccountDatabaseV1()

Example

Parameters

Return type

deleteAccountDatabaseRemoteConnectionV1()

Example

Parameters

Return type

deleteAccountDatabaseV1()

Example

Parameters

Return type

getPhpMyAdminLinkV1()

Example

Parameters

Return type

listAccountDatabaseRemoteConnectionsV1()

Example

Parameters

Return type

listAccountDatabasesV1()

Example

Parameters

Return type

repairDatabaseV1()

Example

Parameters

Return type

`changeDatabasePasswordV1()`

`createAccountDatabaseRemoteConnectionV1()`

`createAccountDatabaseV1()`

`deleteAccountDatabaseRemoteConnectionV1()`

`deleteAccountDatabaseV1()`

`getPhpMyAdminLinkV1()`

`listAccountDatabaseRemoteConnectionsV1()`

`listAccountDatabasesV1()`

`repairDatabaseV1()`