antimatter_api 2.0.13

# \InternalApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**domain_add_access_log_entry**](InternalApi.md#domain_add_access_log_entry) | **POST** /domains/{domainID}/capsules/{capsuleID}/log | Add a capsule audit log entry
[**domain_create_capsule**](InternalApi.md#domain_create_capsule) | **POST** /domains/{domainID}/capsules | Create a capsule
[**domain_data_tagging_hook_invoke**](InternalApi.md#domain_data_tagging_hook_invoke) | **POST** /domains/{domainID}/hooks/data-tagging/{hookName}/invoke | Invoke a hook
[**domain_data_tagging_hook_test**](InternalApi.md#domain_data_tagging_hook_test) | **POST** /domains/{domainID}/hooks/data-tagging/{hookName}/test | Test a classifier rule with real input
[**domain_open_capsule**](InternalApi.md#domain_open_capsule) | **POST** /domains/{domainID}/capsules/{capsuleID}/open | Open a capsule for reading
[**domain_seal_capsule**](InternalApi.md#domain_seal_capsule) | **POST** /domains/{domainID}/capsules/{capsuleID}/seal | Seal a capsule
[**domain_upsert_span_tags**](InternalApi.md#domain_upsert_span_tags) | **PUT** /domains/{domainID}/capsules/{capsuleID}/span-tags | Upsert span-scope tags



## domain_add_access_log_entry

> domain_add_access_log_entry(domain_id, capsule_id, open_token, add_capsule_log_entry_request)
Add a capsule audit log entry

Adds a data-plane audit log entry for this capsule. Contains information about the originating principal and about read tag rollups. Contains an open capsule token (read from the file) to ensure that you legitimately read the capsule. Note that not all audit log entry types may be added with this method. Some (like open records) are generated server side. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**capsule_id** | **String** |  | [required] |
**open_token** | **String** |  | [required] |
**add_capsule_log_entry_request** | [**AddCapsuleLogEntryRequest**](AddCapsuleLogEntryRequest.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_create_capsule

> models::CapsuleCreateResponse domain_create_capsule(domain_id, write_context, body)
Create a capsule

Create a new capsule. The ID will be returned. Capsule will be \"unsealed\" first, meaning it's still in a creating state. Returns a capsule create token that can be used to feed in additional data about the capsule while it's still unsealed. Also returns a DEK and an encrypted DEK. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**write_context** | **String** |  | [required] |
**body** | **serde_json::Value** |  | [required] |

### Return type

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

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

> models::DataTaggingHookResponse domain_data_tagging_hook_invoke(domain_id, hook_name, data_tagging_hook_input, write_context)
Invoke a hook

Invoke a hook that operates on data and returns tags 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**hook_name** | **String** |  | [required] |
**data_tagging_hook_input** | [**DataTaggingHookInput**](DataTaggingHookInput.md) |  | [required] |
**write_context** | Option<**String**> |  |  |

### Return type

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

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

> models::DataTaggingHookResponse domain_data_tagging_hook_test(domain_id, hook_name, domain_data_tagging_hook_test_request)
Test a classifier rule with real input

Invoke a hook that operates on data and returns tags. This endpoint is intended for testing purposes when creating regex or llm rules before adding them to write contexts, or for one-off classification of data without configuring a write context and so forth. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**hook_name** | **String** |  | [required] |
**domain_data_tagging_hook_test_request** | [**DomainDataTaggingHookTestRequest**](DomainDataTaggingHookTestRequest.md) |  | [required] |

### Return type

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

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

> models::CapsuleOpenResponse domain_open_capsule(domain_id, capsule_id, read_context, capsule_open_request)
Open a capsule for reading

Given the encrypted DEK for this capsule, get back the decrypted DEK. contains the read context 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**capsule_id** | **String** |  | [required] |
**read_context** | **String** |  | [required] |
**capsule_open_request** | [**CapsuleOpenRequest**](CapsuleOpenRequest.md) |  | [required] |

### Return type

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

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

> domain_seal_capsule(domain_id, capsule_id, create_token, capsule_seal_request)
Seal a capsule

Seal this capsule, if it's unsealed. Requires capsule create token

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**capsule_id** | **String** |  | [required] |
**create_token** | **String** |  | [required] |
**capsule_seal_request** | [**CapsuleSealRequest**](CapsuleSealRequest.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_upsert_span_tags

> domain_upsert_span_tags(domain_id, capsule_id, create_token, upsert_span_tags_request)
Upsert span-scope tags

Upsert span tag rollups. This is only permitted when a capsule is not sealed. It requires a special \"capsule owner\" token that is returned by create capsule. Note that the rollup calculations must be done on the client side. This method only permits storing the entire rollup, not aggregating serverside. This is idempotent 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**capsule_id** | **String** |  | [required] |
**create_token** | **String** |  | [required] |
**upsert_span_tags_request** | [**UpsertSpanTagsRequest**](UpsertSpanTagsRequest.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)