# \GeneralApi
All URIs are relative to *https://api.antimatter.io/v2*
Method | HTTP request | Description
------------- | ------------- | -------------
[**domain_add_new**](GeneralApi.md#domain_add_new) | **POST** /domains | Add a new domain
[**domain_add_peer_domain**](GeneralApi.md#domain_add_peer_domain) | **POST** /domains/{domainID}/peer-domain | Add a peer domain
[**domain_delete_peer**](GeneralApi.md#domain_delete_peer) | **DELETE** /domains/{domainID}/control/peers/{peerDomainID} | Delete a peer domain
[**domain_get_disaster_recovery_settings**](GeneralApi.md#domain_get_disaster_recovery_settings) | **GET** /domains/{domainID}/control/keys/disaster-recovery | Get a domain's disaster recovery settings.
[**domain_get_peer**](GeneralApi.md#domain_get_peer) | **GET** /domains/{domainID}/peer-domain | Get a peer domain by nickname or alias
[**domain_get_peer_config**](GeneralApi.md#domain_get_peer_config) | **GET** /domains/{domainID}/control/peers/{peerDomainID} | Get peer configuration
[**domain_get_private_info**](GeneralApi.md#domain_get_private_info) | **GET** /domains/{domainID}/info | Get the summary info for a Domain
[**domain_get_public_info**](GeneralApi.md#domain_get_public_info) | **GET** /domains/{domainID}/public-info | Get the public info for a Domain
[**domain_get_settings**](GeneralApi.md#domain_get_settings) | **GET** /domains/{domainID}/control/settings | Get the domain settings
[**domain_get_status**](GeneralApi.md#domain_get_status) | **GET** /domains/{domainID}/control/status | Get the domain status
[**domain_get_vendor_settings**](GeneralApi.md#domain_get_vendor_settings) | **GET** /domains/{domainID}/control/vendor/settings | Get vendor settings for the domain
[**domain_list_peers**](GeneralApi.md#domain_list_peers) | **GET** /domains/{domainID}/control/peers | List domain peers
[**domain_put_disaster_recovery_settings**](GeneralApi.md#domain_put_disaster_recovery_settings) | **PUT** /domains/{domainID}/control/keys/disaster-recovery | Create or update a domain's disaster recovery settings.
[**domain_put_settings**](GeneralApi.md#domain_put_settings) | **PUT** /domains/{domainID}/control/settings | Update the domain settings
[**domain_query_control_log**](GeneralApi.md#domain_query_control_log) | **GET** /domains/{domainID}/control/log | Get the domain control-plane audit log
[**domain_update_peer**](GeneralApi.md#domain_update_peer) | **PUT** /domains/{domainID}/control/peers/{peerDomainID} | Update peer configuration
## domain_add_new
> models::NewDomainResponse domain_add_new(new_domain)
Add a new domain
Add a new domain with no default peer relationships. You will need to confirm the email address before the domain is able to be interacted with.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**new_domain** | [**NewDomain**](NewDomain.md) | | [required] |
### Return type
[**models::NewDomainResponse**](NewDomainResponse.md)
### Authorization
No authorization required
### 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_add_peer_domain
> models::NewDomainResponse domain_add_peer_domain(domain_id, create_peer_domain)
Add a peer domain
Add a domain with a default \"subordinate\" peering relationship with the current domain. Namely, the current \"parent\" domain will be configured to allow the new \"child\" domain to use the parent's billing and admin contact settings, and the child domain will be configured to import those settings. Optionally, similar linking can be performed for identity providers, read/write contexts and facts by setting the appropriate linkX parameter to true. In most cases, what you want is to set `linkAll=true`. Note, that a \"subdomain\" is just shorthand for a domain with the above-described peering config. This peering can be changed at any time, and there is no permanent difference between a domain created in this way, and a domain created with POST /domains.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** | | [required] |
**create_peer_domain** | [**CreatePeerDomain**](CreatePeerDomain.md) | | [required] |
### Return type
[**models::NewDomainResponse**](NewDomainResponse.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_delete_peer
> domain_delete_peer(domain_id, peer_domain_id)
Delete a peer domain
Removes the peering relationship with the given domain
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** | | [required] |
**peer_domain_id** | **String** | | [required] |
### Return type
(empty response body)
### 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_disaster_recovery_settings
> models::DisasterRecoverySettings domain_get_disaster_recovery_settings(domain_id)
Get a domain's disaster recovery settings.
Return the current domain's disaster recovery settings.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** | | [required] |
### Return type
[**models::DisasterRecoverySettings**](DisasterRecoverySettings.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_peer
> models::Domain domain_get_peer(domain_id, nickname, alias)
Get a peer domain by nickname or alias
Retrieve the details of a domain that is configured as a peer of this domain, by using its alias or one of its nicknames
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** | | [required] |
**nickname** | Option<**String**> | | |
**alias** | Option<**String**> | | |
### Return type
[**models::Domain**](Domain.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_peer_config
> models::DomainPeerConfig domain_get_peer_config(domain_id, peer_domain_id)
Get peer configuration
Get the configuration for this peer.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** | | [required] |
**peer_domain_id** | **String** | | [required] |
### Return type
[**models::DomainPeerConfig**](DomainPeerConfig.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_private_info
> models::DomainPrivateInfo domain_get_private_info(domain_id)
Get the summary info for a Domain
Returns a Domain's summary information. This may include more information than the `public-info` endpoint but requires authentication.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** | | [required] |
### Return type
[**models::DomainPrivateInfo**](DomainPrivateInfo.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_public_info
> models::DomainPublicInfo domain_get_public_info(domain_id)
Get the public info for a Domain
Returns a Domain's summary information. This endpoint does not require authorization. This endpoint can be used to determine which identity providers the `/authenticate` endpoint supports.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** | | [required] |
### Return type
[**models::DomainPublicInfo**](DomainPublicInfo.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_get_settings
> models::DomainSettings domain_get_settings(domain_id)
Get the domain settings
Get the domain settings. This contains configuration for the contact email addresses as well as the display name for the domain.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** | | [required] |
### Return type
[**models::DomainSettings**](DomainSettings.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_status
> models::DomainStatus domain_get_status(domain_id)
Get the domain status
The domain status object contains important notifications for administrators of the domain
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** | | [required] |
### Return type
[**models::DomainStatus**](DomainStatus.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_vendor_settings
> models::VendorSettings domain_get_vendor_settings(domain_id)
Get vendor settings for the domain
Return the current vendor settings for a given domain.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** | | [required] |
### Return type
[**models::VendorSettings**](VendorSettings.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_peers
> models::DomainPeerList domain_list_peers(domain_id)
List domain peers
Returns a list of this domains peers
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** | | [required] |
### Return type
[**models::DomainPeerList**](DomainPeerList.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_put_disaster_recovery_settings
> domain_put_disaster_recovery_settings(domain_id, disaster_recovery_settings)
Create or update a domain's disaster recovery settings.
Create or update the current domain's disaster recovery settings.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** | | [required] |
**disaster_recovery_settings** | [**DisasterRecoverySettings**](DisasterRecoverySettings.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_put_settings
> models::DomainSettings domain_put_settings(domain_id, new_domain_settings)
Update the domain settings
Replace the current settings with the new settings supplied.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** | | [required] |
**new_domain_settings** | [**NewDomainSettings**](NewDomainSettings.md) | | [required] |
### Return type
[**models::DomainSettings**](DomainSettings.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_query_control_log
> models::DomainControlLogResults domain_query_control_log(domain_id, start_date, end_date, num_results, start_from_id, session, url, description)
Get the domain control-plane audit log
Query the domain control-plane audit log. 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. | |
**url** | Option<**String**> | the URL you would like to filter on. This is a prefix matched filter and will return results starting with the provided string. If not specified, this field is ignored. | |
**description** | Option<**String**> | the description you would like to filter on. This is an in matched filter and will return results that contain the provided string. If not specified, this field is ignored. | |
### Return type
[**models::DomainControlLogResults**](DomainControlLogResults.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_update_peer
> domain_update_peer(domain_id, peer_domain_id, domain_peer_config)
Update peer configuration
Create or update the configuration for this peer. Please note, if the configuration already exists, it is updated to reflect the values in the request. This will include setting the fields to their default value if not supplied.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** | | [required] |
**peer_domain_id** | **String** | | [required] |
**domain_peer_config** | [**DomainPeerConfig**](DomainPeerConfig.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)