btcpay-client 0.1.0

A client library for BTCPay Server.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

# \APIKeysApi

All URIs are relative to *https://btcpay.example.com/api/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**api_keys_create_api_key**](APIKeysApi.md#api_keys_create_api_key) | **POST** /api/v1/api-keys | Create a new API Key
[**api_keys_delete_api_key**](APIKeysApi.md#api_keys_delete_api_key) | **DELETE** /api/v1/api-keys/{apikey} | Revoke an API Key
[**api_keys_delete_current_api_key**](APIKeysApi.md#api_keys_delete_current_api_key) | **DELETE** /api/v1/api-keys/current | Revoke the current API Key
[**api_keys_get_current_api_key**](APIKeysApi.md#api_keys_get_current_api_key) | **GET** /api/v1/api-keys/current | Get the current API Key information



## api_keys_create_api_key

> crate::models::ApiKeyData api_keys_create_api_key(api_keys_create_api_key_request)
Create a new API Key

Create a new API Key

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**api_keys_create_api_key_request** | Option<[**ApiKeysCreateApiKeyRequest**](ApiKeysCreateApiKeyRequest.md)> |  |  |

### Return type

[**crate::models::ApiKeyData**](ApiKeyData.md)

### Authorization

[API_Key](../README.md#API_Key), [Basic](../README.md#Basic)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## api_keys_delete_api_key

> api_keys_delete_api_key(apikey)
Revoke an API Key

Revoke the current API key so that it cannot be used anymore

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**apikey** | **String** | The API Key to revoke | [required] |

### Return type

 (empty response body)

### Authorization

[API_Key](../README.md#API_Key), [Basic](../README.md#Basic)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## api_keys_delete_current_api_key

> crate::models::ApiKeyData api_keys_delete_current_api_key()
Revoke the current API Key

Revoke the current API key so that it cannot be used anymore

### Parameters

This endpoint does not need any parameter.

### Return type

[**crate::models::ApiKeyData**](ApiKeyData.md)

### Authorization

[API_Key](../README.md#API_Key)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## api_keys_get_current_api_key

> crate::models::ApiKeyData api_keys_get_current_api_key()
Get the current API Key information

View information about the current API key

### Parameters

This endpoint does not need any parameter.

### Return type

[**crate::models::ApiKeyData**](ApiKeyData.md)

### Authorization

[API_Key](../README.md#API_Key)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)