stcloud 0.5.0

Client package for talking to Sematext Cloud.
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

# {{classname}}

All URIs are relative to */*

| Method                                                                     | HTTP request                                                       | Description                               |
| -------------------------------------------------------------------------- | ------------------------------------------------------------------ | ----------------------------------------- |
| [**create_app_token1**](TokensApiControllerApi.md#create_app_token1)       | **POST** users-web/api/v3/apps/{appId}/tokens                      | Create new app token                      |
| [**delete_app_token1**](TokensApiControllerApi.md#delete_app_token1)       | **DELETE** users-web/api/v3/apps/{appId}/tokens/{tokenId}          | Delete app token                          |
| [**get_app_tokens1**](TokensApiControllerApi.md#get_app_tokens1)           | **GET** users-web/api/v3/apps/{appId}/tokens                       | Get app available tokens                  |
| [**regenerate_app_token**](TokensApiControllerApi.md#regenerate_app_token) | **POST** users-web/api/v3/apps/{appId}/tokens/{tokenId}/regenerate | Regenerate app token)                     |
| [**update_app_token1**](TokensApiControllerApi.md#update_app_token1)       | **PUT** users-web/api/v3/apps/{appId}/tokens/{tokenId}             | Update app token (enable/disable or name) |

# **create_app_token1**

> TokenResponse create_app_token1(ctx, body, app_id)
Create new app token

### Required Parameters

| Name       | Type                                    | Description                           | Notes                    |
| ---------- | --------------------------------------- | ------------------------------------- | ------------------------ |
| **ctx**    | **context.Context**                     | context containing the authentication | nil if no authentication |
| **body**   | [**CreateTokenDto**](CreateTokenDto.md) | dto                                   |
| **app_id** | **i64**                                 | appId                                 |

### Return type

[**TokenResponse**](TokenResponse.md)

### Authorization

[api_key](../README.md#api_key),

### 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)

# **delete_app_token1**

> GenericMapBasedApiResponse delete_app_token1(ctx, app_id, token_id)
Delete app token

### Required Parameters

| Name         | Type                | Description                           | Notes                    |
| ------------ | ------------------- | ------------------------------------- | ------------------------ |
| **ctx**      | **context.Context** | context containing the authentication | nil if no authentication |
| **app_id**   | **i64**             | appId                                 |
| **token_id** | **i64**             | tokenId                               |

### Return type

[**GenericMapBasedApiResponse**](Generic Map Based Api Response.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)

# **get_app_tokens1**

> TokensResponse get_app_tokens1(ctx, app_id)
Get app available tokens

### Required Parameters

| Name       | Type                | Description                           | Notes                    |
| ---------- | ------------------- | ------------------------------------- | ------------------------ |
| **ctx**    | **context.Context** | context containing the authentication | nil if no authentication |
| **app_id** | **i64**             | appId                                 |

### Return type

[**TokensResponse**](TokensResponse.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)

# **regenerate_app_token**

> TokenResponse regenerate_app_token(ctx, app_id, token_id)
Regenerate app token)

### Required Parameters

| Name         | Type                | Description                           | Notes                    |
| ------------ | ------------------- | ------------------------------------- | ------------------------ |
| **ctx**      | **context.Context** | context containing the authentication | nil if no authentication |
| **app_id**   | **i64**             | appId                                 |
| **token_id** | **i64**             | tokenId                               |

### Return type

[**TokenResponse**](TokenResponse.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)

# **update_app_token1**

> TokenResponse update_app_token1(ctx, body, app_id, token_id)
Update app token (enable/disable or name)

### Required Parameters

| Name         | Type                                    | Description                           | Notes                    |
| ------------ | --------------------------------------- | ------------------------------------- | ------------------------ |
| **ctx**      | **context.Context**                     | context containing the authentication | nil if no authentication |
| **body**     | [**UpdateTokenDto**](UpdateTokenDto.md) | dto                                   |
| **app_id**   | **i64**                                 | appId                                 |
| **token_id** | **i64**                                 | tokenId                               |

### Return type

[**TokenResponse**](TokenResponse.md)

### Authorization

[api_key](../README.md#api_key),

### 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)