424 lines
16 KiB
Markdown
424 lines
16 KiB
Markdown
# PluginApi
|
|
|
|
All URIs are relative to *http://localhost/*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**disablePlugin**](PluginApi.md#disablePlugin) | **POST** plugin/{id}/disable | Disable a plugin.
|
|
[**enablePlugin**](PluginApi.md#enablePlugin) | **POST** plugin/{id}/enable | Enable a plugin.
|
|
[**getPluginConfig**](PluginApi.md#getPluginConfig) | **GET** plugin/{id}/config | Get YAML configuration for Configurer plugin.
|
|
[**getPluginDisplay**](PluginApi.md#getPluginDisplay) | **GET** plugin/{id}/display | Get display info for a Displayer plugin.
|
|
[**getPlugins**](PluginApi.md#getPlugins) | **GET** plugin | Return all plugins.
|
|
[**updatePluginConfig**](PluginApi.md#updatePluginConfig) | **POST** plugin/{id}/config | Update YAML configuration for Configurer plugin.
|
|
|
|
<a name="disablePlugin"></a>
|
|
# **disablePlugin**
|
|
> Void disablePlugin(id)
|
|
|
|
Disable a plugin.
|
|
|
|
### Example
|
|
```java
|
|
// Import classes:
|
|
//import com.github.gotify.client.ApiClient;
|
|
//import com.github.gotify.client.ApiException;
|
|
//import com.github.gotify.client.Configuration;
|
|
//import com.github.gotify.client.auth.*;
|
|
//import com.github.gotify.client.api.PluginApi;
|
|
|
|
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
|
// Configure HTTP basic authorization: basicAuth
|
|
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
|
|
basicAuth.setUsername("YOUR USERNAME");
|
|
basicAuth.setPassword("YOUR PASSWORD");
|
|
|
|
// Configure API key authorization: clientTokenAuthorizationHeader
|
|
ApiKeyAuth clientTokenAuthorizationHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenAuthorizationHeader");
|
|
clientTokenAuthorizationHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenAuthorizationHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenHeader
|
|
ApiKeyAuth clientTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenHeader");
|
|
clientTokenHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenQuery
|
|
ApiKeyAuth clientTokenQuery = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenQuery");
|
|
clientTokenQuery.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenQuery.setApiKeyPrefix("Token");
|
|
|
|
PluginApi apiInstance = new PluginApi();
|
|
Long id = 789L; // Long | the plugin id
|
|
try {
|
|
Void result = apiInstance.disablePlugin(id);
|
|
System.out.println(result);
|
|
} catch (ApiException e) {
|
|
System.err.println("Exception when calling PluginApi#disablePlugin");
|
|
e.printStackTrace();
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**id** | **Long**| the plugin id |
|
|
|
|
### Return type
|
|
|
|
[**Void**](.md)
|
|
|
|
### Authorization
|
|
|
|
[basicAuth](../README.md#basicAuth)[clientTokenAuthorizationHeader](../README.md#clientTokenAuthorizationHeader)[clientTokenHeader](../README.md#clientTokenHeader)[clientTokenQuery](../README.md#clientTokenQuery)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="enablePlugin"></a>
|
|
# **enablePlugin**
|
|
> Void enablePlugin(id)
|
|
|
|
Enable a plugin.
|
|
|
|
### Example
|
|
```java
|
|
// Import classes:
|
|
//import com.github.gotify.client.ApiClient;
|
|
//import com.github.gotify.client.ApiException;
|
|
//import com.github.gotify.client.Configuration;
|
|
//import com.github.gotify.client.auth.*;
|
|
//import com.github.gotify.client.api.PluginApi;
|
|
|
|
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
|
// Configure HTTP basic authorization: basicAuth
|
|
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
|
|
basicAuth.setUsername("YOUR USERNAME");
|
|
basicAuth.setPassword("YOUR PASSWORD");
|
|
|
|
// Configure API key authorization: clientTokenAuthorizationHeader
|
|
ApiKeyAuth clientTokenAuthorizationHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenAuthorizationHeader");
|
|
clientTokenAuthorizationHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenAuthorizationHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenHeader
|
|
ApiKeyAuth clientTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenHeader");
|
|
clientTokenHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenQuery
|
|
ApiKeyAuth clientTokenQuery = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenQuery");
|
|
clientTokenQuery.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenQuery.setApiKeyPrefix("Token");
|
|
|
|
PluginApi apiInstance = new PluginApi();
|
|
Long id = 789L; // Long | the plugin id
|
|
try {
|
|
Void result = apiInstance.enablePlugin(id);
|
|
System.out.println(result);
|
|
} catch (ApiException e) {
|
|
System.err.println("Exception when calling PluginApi#enablePlugin");
|
|
e.printStackTrace();
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**id** | **Long**| the plugin id |
|
|
|
|
### Return type
|
|
|
|
[**Void**](.md)
|
|
|
|
### Authorization
|
|
|
|
[basicAuth](../README.md#basicAuth)[clientTokenAuthorizationHeader](../README.md#clientTokenAuthorizationHeader)[clientTokenHeader](../README.md#clientTokenHeader)[clientTokenQuery](../README.md#clientTokenQuery)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="getPluginConfig"></a>
|
|
# **getPluginConfig**
|
|
> Object getPluginConfig(id)
|
|
|
|
Get YAML configuration for Configurer plugin.
|
|
|
|
### Example
|
|
```java
|
|
// Import classes:
|
|
//import com.github.gotify.client.ApiClient;
|
|
//import com.github.gotify.client.ApiException;
|
|
//import com.github.gotify.client.Configuration;
|
|
//import com.github.gotify.client.auth.*;
|
|
//import com.github.gotify.client.api.PluginApi;
|
|
|
|
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
|
// Configure HTTP basic authorization: basicAuth
|
|
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
|
|
basicAuth.setUsername("YOUR USERNAME");
|
|
basicAuth.setPassword("YOUR PASSWORD");
|
|
|
|
// Configure API key authorization: clientTokenAuthorizationHeader
|
|
ApiKeyAuth clientTokenAuthorizationHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenAuthorizationHeader");
|
|
clientTokenAuthorizationHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenAuthorizationHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenHeader
|
|
ApiKeyAuth clientTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenHeader");
|
|
clientTokenHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenQuery
|
|
ApiKeyAuth clientTokenQuery = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenQuery");
|
|
clientTokenQuery.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenQuery.setApiKeyPrefix("Token");
|
|
|
|
PluginApi apiInstance = new PluginApi();
|
|
Long id = 789L; // Long | the plugin id
|
|
try {
|
|
Object result = apiInstance.getPluginConfig(id);
|
|
System.out.println(result);
|
|
} catch (ApiException e) {
|
|
System.err.println("Exception when calling PluginApi#getPluginConfig");
|
|
e.printStackTrace();
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**id** | **Long**| the plugin id |
|
|
|
|
### Return type
|
|
|
|
**Object**
|
|
|
|
### Authorization
|
|
|
|
[basicAuth](../README.md#basicAuth)[clientTokenAuthorizationHeader](../README.md#clientTokenAuthorizationHeader)[clientTokenHeader](../README.md#clientTokenHeader)[clientTokenQuery](../README.md#clientTokenQuery)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/x-yaml
|
|
|
|
<a name="getPluginDisplay"></a>
|
|
# **getPluginDisplay**
|
|
> String getPluginDisplay(id)
|
|
|
|
Get display info for a Displayer plugin.
|
|
|
|
### Example
|
|
```java
|
|
// Import classes:
|
|
//import com.github.gotify.client.ApiClient;
|
|
//import com.github.gotify.client.ApiException;
|
|
//import com.github.gotify.client.Configuration;
|
|
//import com.github.gotify.client.auth.*;
|
|
//import com.github.gotify.client.api.PluginApi;
|
|
|
|
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
|
// Configure HTTP basic authorization: basicAuth
|
|
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
|
|
basicAuth.setUsername("YOUR USERNAME");
|
|
basicAuth.setPassword("YOUR PASSWORD");
|
|
|
|
// Configure API key authorization: clientTokenAuthorizationHeader
|
|
ApiKeyAuth clientTokenAuthorizationHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenAuthorizationHeader");
|
|
clientTokenAuthorizationHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenAuthorizationHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenHeader
|
|
ApiKeyAuth clientTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenHeader");
|
|
clientTokenHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenQuery
|
|
ApiKeyAuth clientTokenQuery = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenQuery");
|
|
clientTokenQuery.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenQuery.setApiKeyPrefix("Token");
|
|
|
|
PluginApi apiInstance = new PluginApi();
|
|
Long id = 789L; // Long | the plugin id
|
|
try {
|
|
String result = apiInstance.getPluginDisplay(id);
|
|
System.out.println(result);
|
|
} catch (ApiException e) {
|
|
System.err.println("Exception when calling PluginApi#getPluginDisplay");
|
|
e.printStackTrace();
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**id** | **Long**| the plugin id |
|
|
|
|
### Return type
|
|
|
|
**String**
|
|
|
|
### Authorization
|
|
|
|
[basicAuth](../README.md#basicAuth)[clientTokenAuthorizationHeader](../README.md#clientTokenAuthorizationHeader)[clientTokenHeader](../README.md#clientTokenHeader)[clientTokenQuery](../README.md#clientTokenQuery)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="getPlugins"></a>
|
|
# **getPlugins**
|
|
> List<PluginConf> getPlugins()
|
|
|
|
Return all plugins.
|
|
|
|
### Example
|
|
```java
|
|
// Import classes:
|
|
//import com.github.gotify.client.ApiClient;
|
|
//import com.github.gotify.client.ApiException;
|
|
//import com.github.gotify.client.Configuration;
|
|
//import com.github.gotify.client.auth.*;
|
|
//import com.github.gotify.client.api.PluginApi;
|
|
|
|
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
|
// Configure HTTP basic authorization: basicAuth
|
|
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
|
|
basicAuth.setUsername("YOUR USERNAME");
|
|
basicAuth.setPassword("YOUR PASSWORD");
|
|
|
|
// Configure API key authorization: clientTokenAuthorizationHeader
|
|
ApiKeyAuth clientTokenAuthorizationHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenAuthorizationHeader");
|
|
clientTokenAuthorizationHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenAuthorizationHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenHeader
|
|
ApiKeyAuth clientTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenHeader");
|
|
clientTokenHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenQuery
|
|
ApiKeyAuth clientTokenQuery = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenQuery");
|
|
clientTokenQuery.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenQuery.setApiKeyPrefix("Token");
|
|
|
|
PluginApi apiInstance = new PluginApi();
|
|
try {
|
|
List<PluginConf> result = apiInstance.getPlugins();
|
|
System.out.println(result);
|
|
} catch (ApiException e) {
|
|
System.err.println("Exception when calling PluginApi#getPlugins");
|
|
e.printStackTrace();
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**List<PluginConf>**](PluginConf.md)
|
|
|
|
### Authorization
|
|
|
|
[basicAuth](../README.md#basicAuth)[clientTokenAuthorizationHeader](../README.md#clientTokenAuthorizationHeader)[clientTokenHeader](../README.md#clientTokenHeader)[clientTokenQuery](../README.md#clientTokenQuery)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="updatePluginConfig"></a>
|
|
# **updatePluginConfig**
|
|
> Void updatePluginConfig(id)
|
|
|
|
Update YAML configuration for Configurer plugin.
|
|
|
|
### Example
|
|
```java
|
|
// Import classes:
|
|
//import com.github.gotify.client.ApiClient;
|
|
//import com.github.gotify.client.ApiException;
|
|
//import com.github.gotify.client.Configuration;
|
|
//import com.github.gotify.client.auth.*;
|
|
//import com.github.gotify.client.api.PluginApi;
|
|
|
|
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
|
// Configure HTTP basic authorization: basicAuth
|
|
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
|
|
basicAuth.setUsername("YOUR USERNAME");
|
|
basicAuth.setPassword("YOUR PASSWORD");
|
|
|
|
// Configure API key authorization: clientTokenAuthorizationHeader
|
|
ApiKeyAuth clientTokenAuthorizationHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenAuthorizationHeader");
|
|
clientTokenAuthorizationHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenAuthorizationHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenHeader
|
|
ApiKeyAuth clientTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenHeader");
|
|
clientTokenHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenQuery
|
|
ApiKeyAuth clientTokenQuery = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenQuery");
|
|
clientTokenQuery.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenQuery.setApiKeyPrefix("Token");
|
|
|
|
PluginApi apiInstance = new PluginApi();
|
|
Long id = 789L; // Long | the plugin id
|
|
try {
|
|
Void result = apiInstance.updatePluginConfig(id);
|
|
System.out.println(result);
|
|
} catch (ApiException e) {
|
|
System.err.println("Exception when calling PluginApi#updatePluginConfig");
|
|
e.printStackTrace();
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**id** | **Long**| the plugin id |
|
|
|
|
### Return type
|
|
|
|
[**Void**](.md)
|
|
|
|
### Authorization
|
|
|
|
[basicAuth](../README.md#basicAuth)[clientTokenAuthorizationHeader](../README.md#clientTokenAuthorizationHeader)[clientTokenHeader](../README.md#clientTokenHeader)[clientTokenQuery](../README.md#clientTokenQuery)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|