antimatter_api 2.0.13

Interact with the Antimatter Cloud API
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289

# \CapsulesApi

All URIs are relative to *https://api.antimatter.io/v2*

Method | HTTP request | Description
------------- | ------------- | -------------
[**capsule_get_by_id**](CapsulesApi.md#capsule_get_by_id) | **GET** /capsules/{capsuleID} | Get a Capsule by ID
[**domain_delete_capsule_tags**](CapsulesApi.md#domain_delete_capsule_tags) | **POST** /domains/{domainID}/capsules/{capsuleID}/capsule-tags/delete | Delete capsule-level tags
[**domain_get_capsule_info**](CapsulesApi.md#domain_get_capsule_info) | **GET** /domains/{domainID}/capsules/{capsuleID} | Get capsule info
[**domain_get_tag_info**](CapsulesApi.md#domain_get_tag_info) | **GET** /domains/{domainID}/tag-info | Get an ordered list of the top 100 tags.
[**domain_list_capsules**](CapsulesApi.md#domain_list_capsules) | **GET** /domains/{domainID}/capsules | Get capsule list
[**domain_query_access_log**](CapsulesApi.md#domain_query_access_log) | **GET** /domains/{domainID}/log | Get the domain data-plane audit log
[**domain_query_access_log_single_capsule**](CapsulesApi.md#domain_query_access_log_single_capsule) | **GET** /domains/{domainID}/capsules/{capsuleID}/log | Get the access log for a single capsule
[**domain_upsert_capsule_tags**](CapsulesApi.md#domain_upsert_capsule_tags) | **POST** /domains/{domainID}/capsules/{capsuleID}/capsule-tags | Upsert capsule-scope tags



## capsule_get_by_id

> models::Error capsule_get_by_id(capsule_id)
Get a Capsule by ID

This endpoint allows you to get a Capsule without knowing the Domain ID. It will redirect the user to the full `/domains/{domainID}/capsules/{capsuleID}` path. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**capsule_id** | **String** |  | [required] |

### Return type

[**models::Error**](Error.md)

### Authorization

No authorization required

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


## domain_delete_capsule_tags

> domain_delete_capsule_tags(domain_id, capsule_id, delete_tags)
Delete capsule-level tags

Delete capsule-level tags

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**capsule_id** | **String** |  | [required] |
**delete_tags** | [**DeleteTags**](DeleteTags.md) |  | [required] |

### Return type

 (empty response body)

### Authorization

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

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


## domain_get_capsule_info

> models::CapsuleInfo domain_get_capsule_info(domain_id, capsule_id)
Get capsule info

Get the summary information about this capsule 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**capsule_id** | **String** |  | [required] |

### Return type

[**models::CapsuleInfo**](CapsuleInfo.md)

### Authorization

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

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


## domain_get_tag_info

> models::DomainTagInfoResults domain_get_tag_info(domain_id)
Get an ordered list of the top 100 tags.

Get an ordered list of the top 100 tags. The ordering is: - Tags emitted by hooks - Tags referenced in read context rules - Capsule and span tags that appear in the capsule manifest ordered by number of appearances This list will be truncated (and `has_more` will be true) if the above yields more than 100 tags. There is currently no endpoint to receive a complete list of tags. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |

### Return type

[**models::DomainTagInfoResults**](DomainTagInfoResults.md)

### Authorization

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

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


## domain_list_capsules

> models::CapsuleList domain_list_capsules(domain_id, start_date, end_date, num_results, span_tags, sort_on, start_after, ascending)
Get capsule list

Get information about capsules 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**start_date** | Option<**String**> | the earlier date of the date range. As results are returned in reverse chronological order, this date corresponds with the end of the result set.  |  |[default to 1970-01-01T01:01:01Z]
**end_date** | Option<**String**> | the later date of the date range. As results are returned in reverse chronological order, this date corresponds with the beginning of the result set. If not specified, defaults to the current time.  |  |
**num_results** | Option<**i32**> | the number of results you would like returned. You may get more or less than this number, and it does not indicate anything about the availability of more records. Consult the returned \"has_more\" field to determine if there are more records available matching the filters and time range.  |  |[default to 100]
**span_tags** | Option<**String**> | the span tags you would like to filter on. This accepts a tag key only and will return all span tag key  results matching the provided tag key. If not specified, this field is ignored.  |  |
**sort_on** | Option<**String**> | the capsule field you would like to sort on. This accepts the field only and will return results ordered on the provided field. If not specified, this field is ignored.  |  |
**start_after** | Option<**String**> | the pagination key you would like to retrieve results after. This accepts the pagination key only and works in combination with the sort_on parameter to return records strictly after the provided pagination key. If not  specified, this field is ignored.  |  |
**ascending** | Option<**bool**> | the defines whether a sorted result should be order ascending. This accepts a boolean value and when true will work in combination with the sort_on and start_after parameters to return values in ascending order. If not  specified, this field is ignored and treated as false.  |  |

### Return type

[**models::CapsuleList**](CapsuleList.md)

### Authorization

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

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


## domain_query_access_log

> models::AccessLogResults domain_query_access_log(domain_id, start_date, end_date, num_results, start_from_id, session, location, location_prefixed, operation_type, allowed_tag, redacted_or_tokenized_tag)
Get the domain data-plane audit log

Query the data access log for this domain. This contains all operations interacting with capsules within this domain. Results are returned in reverse chronological order 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**start_date** | Option<**String**> | the earlier date of the date range. As results are returned in reverse chronological order, this date corresponds with the end of the result set.  |  |[default to 1970-01-01T01:01:01Z]
**end_date** | Option<**String**> | the later date of the date range. As results are returned in reverse chronological order, this date corresponds with the beginning of the result set. If not specified, defaults to the current time.  |  |
**num_results** | Option<**i32**> | the number of results you would like returned. You may get more or less than this number, and it does not indicate anything about the availability of more records. Consult the returned \"has_more\" field to determine if there are more records available matching the filters and time range.  |  |[default to 100]
**start_from_id** | Option<**String**> | which id to start from. This must be an ID of a record previously returned. The first result will have an ID less than this ID (because results are in reverse chronological order, and it is non-inclusive). You should omit this field if you are not continuing a paginated query.  |  |
**session** | Option<**String**> | the session you would like to filter on. This will return results for only the provided session. If not specified, this field is ignored.  |  |
**location** | Option<**String**> | the location you would like to filter on. This is a matched filter and will return results starting with the provided string. If not specified, this field is ignored.  |  |
**location_prefixed** | Option<**bool**> | a boolean indicator to indicate that the location you provided is a prefix or not. If this is set to true, then the filter provided in location is treated as a prefix. If not specified, this is treated as false.  |  |
**operation_type** | Option<**String**> | the operation you would like to filter on. This will filter on the provided operation type and return all results using the provided operation type. If not specified, this field is ignored.  |  |
**allowed_tag** | Option<**String**> | the allow tag key you would like to filter on. This accepts tag key only and will return all allowed tag results matching the provided tag key. If not specified, this field is ignored.  |  |
**redacted_or_tokenized_tag** | Option<**String**> | the redacted or tokenized tag key you would like ot filter on. This accepts a tag key only and will return all redacted and tokenized tag key results matching the provided tag key. If not specified, this field is ignored.  |  |

### Return type

[**models::AccessLogResults**](AccessLogResults.md)

### Authorization

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

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


## domain_query_access_log_single_capsule

> models::AccessLogResults domain_query_access_log_single_capsule(domain_id, capsule_id, start_date, end_date, num_results, start_from_id, session, location, location_prefixed, operation_type, allowed_tag, redacted_or_tokenized_tag)
Get the access log for a single capsule

Query the data-plane access log for this capsule. Results are returned in reverse chronological order. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**capsule_id** | **String** |  | [required] |
**start_date** | Option<**String**> | the earlier date of the date range. As results are returned in reverse chronological order, this date corresponds with the end of the result set.  |  |[default to 1970-01-01T01:01:01Z]
**end_date** | Option<**String**> | the later date of the date range. As results are returned in reverse chronological order, this date corresponds with the beginning of the result set. If not specified, defaults to the current time.  |  |
**num_results** | Option<**i32**> | the number of results you would like returned. You may get more or less than this number, and it does not indicate anything about the availability of more records. Consult the returned \"has_more\" field to determine if there are more records available matching the filters and time range.  |  |[default to 100]
**start_from_id** | Option<**String**> | which id to start from. This must be an ID of a record previously returned. The first result will have an ID less than this ID (because results are in reverse chronological order, and it is non-inclusive). You should omit this field if you are not continuing a paginated query.  |  |
**session** | Option<**String**> | the session you would like to filter on. This will return results for only the provided session. If not specified, this field is ignored.  |  |
**location** | Option<**String**> | the location you would like to filter on. This is a matched filter and will return results starting with the provided string. If not specified, this field is ignored.  |  |
**location_prefixed** | Option<**bool**> | a boolean indicator to indicate that the location you provided is a prefix or not. If this is set to true, then the filter provided in location is treated as a prefix. If not specified, this is treated as false.  |  |
**operation_type** | Option<**String**> | the operation you would like to filter on. This will filter on the provided operation type and return all results using the provided operation type. If not specified, this field is ignored.  |  |
**allowed_tag** | Option<**String**> | the allow tag key you would like to filter on. This accepts tag key only and will return all allowed tag results matching the provided tag key. If not specified, this field is ignored.  |  |
**redacted_or_tokenized_tag** | Option<**String**> | the redacted or tokenized tag key you would like ot filter on. This accepts a tag key only and will return all redacted and tokenized tag key results matching the provided tag key. If not specified, this field is ignored.  |  |

### Return type

[**models::AccessLogResults**](AccessLogResults.md)

### Authorization

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

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


## domain_upsert_capsule_tags

> domain_upsert_capsule_tags(domain_id, capsule_id, domain_upsert_capsule_tags_request)
Upsert capsule-scope tags

Upsert capsule-level tags. This is permitted even after a capsule is sealed. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**capsule_id** | **String** |  | [required] |
**domain_upsert_capsule_tags_request** | [**DomainUpsertCapsuleTagsRequest**](DomainUpsertCapsuleTagsRequest.md) |  | [required] |

### Return type

 (empty response body)

### Authorization

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

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