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

# {{classname}}

All URIs are relative to */*

| Method                                                                                  | HTTP request                                                | Description                |
| --------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -------------------------- |
| [**create_alert_using_post**](AlertsApi.md#create_alert_using_post)                     | **POST** users-web/api/v3/alerts                            | Create alert rule          |
| [**delete_alert_rule_using_delete**](AlertsApi.md#delete_alert_rule_using_delete)       | **DELETE** users-web/api/v3/alerts/{updateableAlertId}      | Delete alert rule          |
| [**disable_alert_rule_using_put**](AlertsApi.md#disable_alert_rule_using_put)           | **PUT** users-web/api/v3/alerts/{updateableAlertId}/disable | Disable alert rule         |
| [**enable_alert_rule_using_put**](AlertsApi.md#enable_alert_rule_using_put)             | **PUT** users-web/api/v3/alerts/{updateableAlertId}/enable  | Enable alert rule          |
| [**get_alert_rules_for_app_using_get**](AlertsApi.md#get_alert_rules_for_app_using_get) | **GET** users-web/api/v3/apps/{appId}/alerts                | Get alert rules for an app |

# **create_alert_using_post**

> AlertRuleResponse create_alert_using_post(ctx, body)
Create alert rule

### Required Parameters

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

### Return type

[**AlertRuleResponse**](AlertRuleResponse.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_alert_rule_using_delete**

> GenericMapBasedApiResponse delete_alert_rule_using_delete(ctx, updateable_alert_id)
Delete alert rule

### Required Parameters

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

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

# **disable_alert_rule_using_put**

> GenericMapBasedApiResponse disable_alert_rule_using_put(ctx, updateable_alert_id)
Disable alert rule

### Required Parameters

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

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

# **enable_alert_rule_using_put**

> GenericMapBasedApiResponse enable_alert_rule_using_put(ctx, updateable_alert_id)
Enable alert rule

### Required Parameters

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

### 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_alert_rules_for_app_using_get**

> AlertRulesResponse get_alert_rules_for_app_using_get(ctx, app_id)
Get alert rules for an app

### Required Parameters

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

### Return type

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