200 lines
6.4 KiB
Markdown
200 lines
6.4 KiB
Markdown
# ClientApi
|
|
|
|
All URIs are relative to *http://localhost*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**createClient**](ClientApi.md#createClient) | **POST** client | Create a client.
|
|
[**deleteClient**](ClientApi.md#deleteClient) | **DELETE** client/{id} | Delete a client.
|
|
[**getClients**](ClientApi.md#getClients) | **GET** client | Return all clients.
|
|
|
|
|
|
<a name="createClient"></a>
|
|
# **createClient**
|
|
> Client createClient(body)
|
|
|
|
Create a client.
|
|
|
|
### 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.ClientApi;
|
|
|
|
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: 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");
|
|
|
|
ClientApi apiInstance = new ClientApi();
|
|
Client body = new Client(); // Client | the client to add
|
|
try {
|
|
Client result = apiInstance.createClient(body);
|
|
System.out.println(result);
|
|
} catch (ApiException e) {
|
|
System.err.println("Exception when calling ClientApi#createClient");
|
|
e.printStackTrace();
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**body** | [**Client**](Client.md)| the client to add |
|
|
|
|
### Return type
|
|
|
|
[**Client**](Client.md)
|
|
|
|
### Authorization
|
|
|
|
[basicAuth](../README.md#basicAuth), [clientTokenHeader](../README.md#clientTokenHeader), [clientTokenQuery](../README.md#clientTokenQuery)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
<a name="deleteClient"></a>
|
|
# **deleteClient**
|
|
> Void deleteClient(id)
|
|
|
|
Delete a client.
|
|
|
|
### 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.ClientApi;
|
|
|
|
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: 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");
|
|
|
|
ClientApi apiInstance = new ClientApi();
|
|
Integer id = 56; // Integer | the client id
|
|
try {
|
|
Void result = apiInstance.deleteClient(id);
|
|
System.out.println(result);
|
|
} catch (ApiException e) {
|
|
System.err.println("Exception when calling ClientApi#deleteClient");
|
|
e.printStackTrace();
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**id** | **Integer**| the client id |
|
|
|
|
### Return type
|
|
|
|
[**Void**](.md)
|
|
|
|
### Authorization
|
|
|
|
[basicAuth](../README.md#basicAuth), [clientTokenHeader](../README.md#clientTokenHeader), [clientTokenQuery](../README.md#clientTokenQuery)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
<a name="getClients"></a>
|
|
# **getClients**
|
|
> List<Client> getClients()
|
|
|
|
Return all clients.
|
|
|
|
### 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.ClientApi;
|
|
|
|
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: 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");
|
|
|
|
ClientApi apiInstance = new ClientApi();
|
|
try {
|
|
List<Client> result = apiInstance.getClients();
|
|
System.out.println(result);
|
|
} catch (ApiException e) {
|
|
System.err.println("Exception when calling ClientApi#getClients");
|
|
e.printStackTrace();
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**List<Client>**](Client.md)
|
|
|
|
### Authorization
|
|
|
|
[basicAuth](../README.md#basicAuth), [clientTokenHeader](../README.md#clientTokenHeader), [clientTokenQuery](../README.md#clientTokenQuery)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|