All URIs are relative to https://localhost/api/v5
Method | HTTP request | Description |
---|---|---|
listProperties | GET /server/properties | List server properties |
modifyProperties | PUT /server/properties | Modify server properties |
\Swagger\Client\Model\ServerProperty[] listProperties($details, $accept, $pretty)
List server properties
Get the main server properties (server.properties file). Required permissions: - server.properties.list
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyHeader
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-WebAPI-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-WebAPI-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('key', 'Bearer');
$apiInstance = new Swagger\Client\Api\ServerApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$details = true; // bool | Add to include additional details, omit or false otherwise
$accept = "accept_example"; // string | Override the 'Accept' request header (useful for debugging your requests)
$pretty = true; // bool | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
$result = $apiInstance->listProperties($details, $accept, $pretty);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ServerApi->listProperties: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
details | bool | Add to include additional details, omit or false otherwise | [optional] |
accept | string | Override the 'Accept' request header (useful for debugging your requests) | [optional] |
pretty | bool | Add to make the Web-API pretty print the response (useful for debugging your requests) | [optional] |
\Swagger\Client\Model\ServerProperty[]
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\ServerProperty[] modifyProperties($body, $details, $accept, $pretty)
Modify server properties
Modify settings in the server.properties file. **Note that these settings don't take effect until you restart the server. Required permissions: - server.properties.modify - server.properties.modify.[property]
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyHeader
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-WebAPI-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-WebAPI-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('key', 'Bearer');
$apiInstance = new Swagger\Client\Api\ServerApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$body = new \stdClass; // object |
$details = true; // bool | Add to include additional details, omit or false otherwise
$accept = "accept_example"; // string | Override the 'Accept' request header (useful for debugging your requests)
$pretty = true; // bool | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
$result = $apiInstance->modifyProperties($body, $details, $accept, $pretty);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ServerApi->modifyProperties: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | object | [optional] | |
details | bool | Add to include additional details, omit or false otherwise | [optional] |
accept | string | Override the 'Accept' request header (useful for debugging your requests) | [optional] |
pretty | bool | Add to make the Web-API pretty print the response (useful for debugging your requests) | [optional] |
\Swagger\Client\Model\ServerProperty[]
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]