`antimatter.client.api.default_api`#

Antimatter Public API

Interact with the Antimatter Cloud API

The version of the OpenAPI document: 1.1.3 Contact: support@antimatter.io Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

Module Contents#

Classes#

DefaultApi

NOTE: This class is auto generated by OpenAPI Generator

class antimatter.client.api.default_api.DefaultApi(api_client=None)#

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

capsule_get_by_id(capsule_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.error.Error#

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:

capsule_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

capsule_get_by_id_with_http_info(capsule_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.error.Error]#

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:

capsule_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

capsule_get_by_id_without_preload_content(capsule_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

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:

capsule_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_add_access_log_entry(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], add_capsule_log_entry_request: antimatter.client.models.add_capsule_log_entry_request.AddCapsuleLogEntryRequest, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

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:

domain_id (str) – (required)
capsule_id (str) – (required)
add_capsule_log_entry_request (AddCapsuleLogEntryRequest) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_add_access_log_entry_with_http_info(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], add_capsule_log_entry_request: antimatter.client.models.add_capsule_log_entry_request.AddCapsuleLogEntryRequest, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Add a capsule audit log entry

Parameters:

domain_id (str) – (required)
capsule_id (str) – (required)
add_capsule_log_entry_request (AddCapsuleLogEntryRequest) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_add_access_log_entry_without_preload_content(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], add_capsule_log_entry_request: antimatter.client.models.add_capsule_log_entry_request.AddCapsuleLogEntryRequest, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Add a capsule audit log entry

Parameters:

domain_id (str) – (required)
capsule_id (str) – (required)
add_capsule_log_entry_request (AddCapsuleLogEntryRequest) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_add_external_root_encryption_key(domain_id: Annotated[str, Field(strict=True)], key_infos: antimatter.client.models.key_infos.KeyInfos, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.root_encryption_key_id_response.RootEncryptionKeyIDResponse#

Add a new external root encryption key.

Add a new external credentials that can be used as the domain’s root encryption key.

Parameters:

domain_id (str) – (required)
key_infos (KeyInfos) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_add_external_root_encryption_key_with_http_info(domain_id: Annotated[str, Field(strict=True)], key_infos: antimatter.client.models.key_infos.KeyInfos, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.root_encryption_key_id_response.RootEncryptionKeyIDResponse]#

Add a new external root encryption key.

Add a new external credentials that can be used as the domain’s root encryption key.

Parameters:

domain_id (str) – (required)
key_infos (KeyInfos) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_add_external_root_encryption_key_without_preload_content(domain_id: Annotated[str, Field(strict=True)], key_infos: antimatter.client.models.key_infos.KeyInfos, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Add a new external root encryption key.

Add a new external credentials that can be used as the domain’s root encryption key.

Parameters:

domain_id (str) – (required)
key_infos (KeyInfos) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_add_new(new_domain: antimatter.client.models.new_domain.NewDomain, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.new_domain_response.NewDomainResponse#

Add a new domain

Add a new domain with no default peer relationships.

Parameters:

new_domain (NewDomain) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_add_new_with_http_info(new_domain: antimatter.client.models.new_domain.NewDomain, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.new_domain_response.NewDomainResponse]#

Add a new domain

Add a new domain with no default peer relationships.

Parameters:

new_domain (NewDomain) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_add_new_without_preload_content(new_domain: antimatter.client.models.new_domain.NewDomain, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Add a new domain

Add a new domain with no default peer relationships.

Parameters:

new_domain (NewDomain) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_add_read_context_rule(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], new_read_context_config_rule: antimatter.client.models.new_read_context_config_rule.NewReadContextConfigRule, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_add_read_context_rule200_response.DomainAddReadContextRule200Response#

Add a read context configuration rule

Read context configuration is rule based, much like domain policy. This adds a new rule to the read context. Rules are processed in priority order, stopping with the first matching rule.

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
new_read_context_config_rule (NewReadContextConfigRule) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_add_read_context_rule_with_http_info(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], new_read_context_config_rule: antimatter.client.models.new_read_context_config_rule.NewReadContextConfigRule, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_add_read_context_rule200_response.DomainAddReadContextRule200Response]#

Add a read context configuration rule

Read context configuration is rule based, much like domain policy. This adds a new rule to the read context. Rules are processed in priority order, stopping with the first matching rule.

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
new_read_context_config_rule (NewReadContextConfigRule) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_add_read_context_rule_without_preload_content(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], new_read_context_config_rule: antimatter.client.models.new_read_context_config_rule.NewReadContextConfigRule, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Add a read context configuration rule

Read context configuration is rule based, much like domain policy. This adds a new rule to the read context. Rules are processed in priority order, stopping with the first matching rule.

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
new_read_context_config_rule (NewReadContextConfigRule) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_authenticate(domain_id: Annotated[str, Field(strict=True)], domain_authenticate: antimatter.client.models.domain_authenticate.DomainAuthenticate, identity_provider_name: Optional[Annotated[str, Field(strict=True)]] = None, token_exchange: pydantic.StrictBool | None = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_authenticate_response.DomainAuthenticateResponse#

Authenticate with a domain

Use an authentication method to obtain a domain ID token

Parameters:

domain_id (str) – (required)
domain_authenticate (DomainAuthenticate) – (required)
identity_provider_name (str) –
token_exchange (bool) –
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_authenticate_with_http_info(domain_id: Annotated[str, Field(strict=True)], domain_authenticate: antimatter.client.models.domain_authenticate.DomainAuthenticate, identity_provider_name: Optional[Annotated[str, Field(strict=True)]] = None, token_exchange: pydantic.StrictBool | None = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_authenticate_response.DomainAuthenticateResponse]#

Authenticate with a domain

Use an authentication method to obtain a domain ID token

Parameters:

domain_id (str) – (required)
domain_authenticate (DomainAuthenticate) – (required)
identity_provider_name (str) –
token_exchange (bool) –
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_authenticate_without_preload_content(domain_id: Annotated[str, Field(strict=True)], domain_authenticate: antimatter.client.models.domain_authenticate.DomainAuthenticate, identity_provider_name: Optional[Annotated[str, Field(strict=True)]] = None, token_exchange: pydantic.StrictBool | None = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Authenticate with a domain

Use an authentication method to obtain a domain ID token

Parameters:

domain_id (str) – (required)
domain_authenticate (DomainAuthenticate) – (required)
identity_provider_name (str) –
token_exchange (bool) –
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_contact_issue_verify(domain_id: Annotated[str, Field(strict=True)], domain_contact_issue_verify_request: antimatter.client.models.domain_contact_issue_verify_request.DomainContactIssueVerifyRequest, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Issue a new verification request

Issue a new verification request to a admin account associated with the domain that is currently in the pending state.

Parameters:

domain_id (str) – (required)
domain_contact_issue_verify_request (DomainContactIssueVerifyRequest) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_contact_issue_verify_with_http_info(domain_id: Annotated[str, Field(strict=True)], domain_contact_issue_verify_request: antimatter.client.models.domain_contact_issue_verify_request.DomainContactIssueVerifyRequest, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Issue a new verification request

Issue a new verification request to a admin account associated with the domain that is currently in the pending state.

Parameters:

domain_id (str) – (required)
domain_contact_issue_verify_request (DomainContactIssueVerifyRequest) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_contact_issue_verify_without_preload_content(domain_id: Annotated[str, Field(strict=True)], domain_contact_issue_verify_request: antimatter.client.models.domain_contact_issue_verify_request.DomainContactIssueVerifyRequest, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Issue a new verification request

Issue a new verification request to a admin account associated with the domain that is currently in the pending state.

Parameters:

domain_id (str) – (required)
domain_contact_issue_verify_request (DomainContactIssueVerifyRequest) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_contact_verify(domain_id: Annotated[str, Field(strict=True)], token: Annotated[pydantic.StrictStr, Field(description='Security token issued with verification request')], address: Annotated[pydantic.StrictStr, Field(description='Email address to be tested against the supplied token')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.verify_contact_response.VerifyContactResponse#

Verify an admin account recently associated with a domain

Verify an admin account recently associated with a domain. The token will be submitted to the account address as part of a callback link to this endpoint.

Parameters:

domain_id (str) – (required)
token (str) – Security token issued with verification request (required)
address (str) – Email address to be tested against the supplied token (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_contact_verify_with_http_info(domain_id: Annotated[str, Field(strict=True)], token: Annotated[pydantic.StrictStr, Field(description='Security token issued with verification request')], address: Annotated[pydantic.StrictStr, Field(description='Email address to be tested against the supplied token')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.verify_contact_response.VerifyContactResponse]#

Verify an admin account recently associated with a domain

Verify an admin account recently associated with a domain. The token will be submitted to the account address as part of a callback link to this endpoint.

Parameters:

domain_id (str) – (required)
token (str) – Security token issued with verification request (required)
address (str) – Email address to be tested against the supplied token (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_contact_verify_without_preload_content(domain_id: Annotated[str, Field(strict=True)], token: Annotated[pydantic.StrictStr, Field(description='Security token issued with verification request')], address: Annotated[pydantic.StrictStr, Field(description='Email address to be tested against the supplied token')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Verify an admin account recently associated with a domain

Verify an admin account recently associated with a domain. The token will be submitted to the account address as part of a callback link to this endpoint.

Parameters:

domain_id (str) – (required)
token (str) – Security token issued with verification request (required)
address (str) – Email address to be tested against the supplied token (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_create_capsule(domain_id: Annotated[str, Field(strict=True)], write_context: Annotated[str, Field(strict=True)], body: Dict[str, Any], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.capsule_create_response.CapsuleCreateResponse#

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:

domain_id (str) – (required)
write_context (str) – (required)
body (object) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_create_capsule_with_http_info(domain_id: Annotated[str, Field(strict=True)], write_context: Annotated[str, Field(strict=True)], body: Dict[str, Any], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.capsule_create_response.CapsuleCreateResponse]#

Create a capsule

Parameters:

domain_id (str) – (required)
write_context (str) – (required)
body (object) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_create_capsule_without_preload_content(domain_id: Annotated[str, Field(strict=True)], write_context: Annotated[str, Field(strict=True)], body: Dict[str, Any], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Create a capsule

Parameters:

domain_id (str) – (required)
write_context (str) – (required)
body (object) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_create_peer_domain(domain_id: Annotated[str, Field(strict=True)], create_peer_domain: antimatter.client.models.create_peer_domain.CreatePeerDomain, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.new_domain_response.NewDomainResponse#

Create a peer domain

Create 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:

domain_id (str) – (required)
create_peer_domain (CreatePeerDomain) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_create_peer_domain_with_http_info(domain_id: Annotated[str, Field(strict=True)], create_peer_domain: antimatter.client.models.create_peer_domain.CreatePeerDomain, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.new_domain_response.NewDomainResponse]#

Create a peer domain

Parameters:

domain_id (str) – (required)
create_peer_domain (CreatePeerDomain) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_create_peer_domain_without_preload_content(domain_id: Annotated[str, Field(strict=True)], create_peer_domain: antimatter.client.models.create_peer_domain.CreatePeerDomain, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Create a peer domain

Parameters:

domain_id (str) – (required)
create_peer_domain (CreatePeerDomain) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_create_policy_rule(domain_id: Annotated[str, Field(strict=True)], domain_policy_rule: antimatter.client.models.domain_policy_rule.DomainPolicyRule, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_policy_rule.DomainPolicyRule#

Create a domain policy rule

Parameters:

domain_id (str) – (required)
domain_policy_rule (DomainPolicyRule) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_create_policy_rule_with_http_info(domain_id: Annotated[str, Field(strict=True)], domain_policy_rule: antimatter.client.models.domain_policy_rule.DomainPolicyRule, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_policy_rule.DomainPolicyRule]#

Create a domain policy rule

Parameters:

domain_id (str) – (required)
domain_policy_rule (DomainPolicyRule) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_create_policy_rule_without_preload_content(domain_id: Annotated[str, Field(strict=True)], domain_policy_rule: antimatter.client.models.domain_policy_rule.DomainPolicyRule, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Create a domain policy rule

Parameters:

domain_id (str) – (required)
domain_policy_rule (DomainPolicyRule) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_data_tagging_hook_invoke(domain_id: Annotated[str, Field(strict=True)], hook_name: Annotated[str, Field(strict=True)], data_tagging_hook_input: antimatter.client.models.data_tagging_hook_input.DataTaggingHookInput, write_context: Optional[Annotated[str, Field(strict=True)]] = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.data_tagging_hook_response.DataTaggingHookResponse#

Invoke a hook

Invoke a hook that operates on data and returns tags

Parameters:

domain_id (str) – (required)
hook_name (str) – (required)
data_tagging_hook_input (DataTaggingHookInput) – (required)
write_context (str) –
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_data_tagging_hook_invoke_with_http_info(domain_id: Annotated[str, Field(strict=True)], hook_name: Annotated[str, Field(strict=True)], data_tagging_hook_input: antimatter.client.models.data_tagging_hook_input.DataTaggingHookInput, write_context: Optional[Annotated[str, Field(strict=True)]] = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.data_tagging_hook_response.DataTaggingHookResponse]#

Invoke a hook

Invoke a hook that operates on data and returns tags

Parameters:

domain_id (str) – (required)
hook_name (str) – (required)
data_tagging_hook_input (DataTaggingHookInput) – (required)
write_context (str) –
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_data_tagging_hook_invoke_without_preload_content(domain_id: Annotated[str, Field(strict=True)], hook_name: Annotated[str, Field(strict=True)], data_tagging_hook_input: antimatter.client.models.data_tagging_hook_input.DataTaggingHookInput, write_context: Optional[Annotated[str, Field(strict=True)]] = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Invoke a hook

Invoke a hook that operates on data and returns tags

Parameters:

domain_id (str) – (required)
hook_name (str) – (required)
data_tagging_hook_input (DataTaggingHookInput) – (required)
write_context (str) –
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_capability(domain_id: Annotated[str, Field(strict=True)], capability: Annotated[str, Field(strict=True, description='the name for this capability, like "admin"')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Delete a capability

Delete a capability. All rules that reference the capability must have already been deleted, or you will get an error

Parameters:

domain_id (str) – (required)
capability (str) – the name for this capability, like “admin” (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_capability_with_http_info(domain_id: Annotated[str, Field(strict=True)], capability: Annotated[str, Field(strict=True, description='the name for this capability, like "admin"')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Delete a capability

Delete a capability. All rules that reference the capability must have already been deleted, or you will get an error

Parameters:

domain_id (str) – (required)
capability (str) – the name for this capability, like “admin” (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_capability_without_preload_content(domain_id: Annotated[str, Field(strict=True)], capability: Annotated[str, Field(strict=True, description='the name for this capability, like "admin"')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Delete a capability

Delete a capability. All rules that reference the capability must have already been deleted, or you will get an error

Parameters:

domain_id (str) – (required)
capability (str) – the name for this capability, like “admin” (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_capsule_tags(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], delete_tags: antimatter.client.models.delete_tags.DeleteTags, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Delete capsule-level tags

Parameters:

domain_id (str) – (required)
capsule_id (str) – (required)
delete_tags (DeleteTags) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_capsule_tags_with_http_info(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], delete_tags: antimatter.client.models.delete_tags.DeleteTags, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Delete capsule-level tags

Parameters:

domain_id (str) – (required)
capsule_id (str) – (required)
delete_tags (DeleteTags) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_capsule_tags_without_preload_content(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], delete_tags: antimatter.client.models.delete_tags.DeleteTags, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Delete capsule-level tags

Parameters:

domain_id (str) – (required)
capsule_id (str) – (required)
delete_tags (DeleteTags) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_external_root_encryption_key(domain_id: Annotated[str, Field(strict=True)], root_encryption_key_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Delete an external root encryption key by ID.

Delete an external root encryption key using its ID. This operation is only successful if the external root encryption key is not in use by any data key encryption keys.

Parameters:

domain_id (str) – (required)
root_encryption_key_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_external_root_encryption_key_with_http_info(domain_id: Annotated[str, Field(strict=True)], root_encryption_key_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Delete an external root encryption key by ID.

Delete an external root encryption key using its ID. This operation is only successful if the external root encryption key is not in use by any data key encryption keys.

Parameters:

domain_id (str) – (required)
root_encryption_key_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_external_root_encryption_key_without_preload_content(domain_id: Annotated[str, Field(strict=True)], root_encryption_key_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Delete an external root encryption key by ID.

Delete an external root encryption key using its ID. This operation is only successful if the external root encryption key is not in use by any data key encryption keys.

Parameters:

domain_id (str) – (required)
root_encryption_key_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_fact_by_id(domain_id: Annotated[str, Field(strict=True)], fact_type: Annotated[str, Field(strict=True, description='the "type name" for this fact, like "has_role"')], fact_id: Annotated[str, Field(strict=True, description='the ID for the fact to be deleted.')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Delete a fact

Delete a fact by ID

Parameters:

domain_id (str) – (required)
fact_type (str) – the “type name” for this fact, like “has_role” (required)
fact_id (str) – the ID for the fact to be deleted. (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_fact_by_id_with_http_info(domain_id: Annotated[str, Field(strict=True)], fact_type: Annotated[str, Field(strict=True, description='the "type name" for this fact, like "has_role"')], fact_id: Annotated[str, Field(strict=True, description='the ID for the fact to be deleted.')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Delete a fact

Delete a fact by ID

Parameters:

domain_id (str) – (required)
fact_type (str) – the “type name” for this fact, like “has_role” (required)
fact_id (str) – the ID for the fact to be deleted. (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_fact_by_id_without_preload_content(domain_id: Annotated[str, Field(strict=True)], fact_type: Annotated[str, Field(strict=True, description='the "type name" for this fact, like "has_role"')], fact_id: Annotated[str, Field(strict=True, description='the ID for the fact to be deleted.')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Delete a fact

Delete a fact by ID

Parameters:

domain_id (str) – (required)
fact_type (str) – the “type name” for this fact, like “has_role” (required)
fact_id (str) – the ID for the fact to be deleted. (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_fact_type(domain_id: Annotated[str, Field(strict=True)], fact_type: Annotated[str, Field(strict=True, description='the "type name" for this fact, like "has_role"')], confirm: Annotated[str, Field(strict=True, description='the fact type again, to confirm you really want to delete it')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Delete a fact type

Deletes a fact type and all facts inside it

Parameters:

domain_id (str) – (required)
fact_type (str) – the “type name” for this fact, like “has_role” (required)
confirm (str) – the fact type again, to confirm you really want to delete it (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_fact_type_with_http_info(domain_id: Annotated[str, Field(strict=True)], fact_type: Annotated[str, Field(strict=True, description='the "type name" for this fact, like "has_role"')], confirm: Annotated[str, Field(strict=True, description='the fact type again, to confirm you really want to delete it')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Delete a fact type

Deletes a fact type and all facts inside it

Parameters:

domain_id (str) – (required)
fact_type (str) – the “type name” for this fact, like “has_role” (required)
confirm (str) – the fact type again, to confirm you really want to delete it (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_fact_type_without_preload_content(domain_id: Annotated[str, Field(strict=True)], fact_type: Annotated[str, Field(strict=True, description='the "type name" for this fact, like "has_role"')], confirm: Annotated[str, Field(strict=True, description='the fact type again, to confirm you really want to delete it')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Delete a fact type

Deletes a fact type and all facts inside it

Parameters:

domain_id (str) – (required)
fact_type (str) – the “type name” for this fact, like “has_role” (required)
confirm (str) – the fact type again, to confirm you really want to delete it (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_identity_provider(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Delete an identity provider

Delete an identity provider. All domain tokens created using this identity provider will be invalidated. Take care not to remove the identity provider that is providing you admin access to your domain, as you may “lock yourself out”.

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_identity_provider_with_http_info(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Delete an identity provider

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_identity_provider_without_preload_content(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Delete an identity provider

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_identity_provider_principal(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], principal_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Delete identity provider principal

Delete an identity provider principal.

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
principal_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_identity_provider_principal_with_http_info(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], principal_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Delete identity provider principal

Delete an identity provider principal.

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
principal_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_identity_provider_principal_without_preload_content(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], principal_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Delete identity provider principal

Delete an identity provider principal.

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
principal_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_peer(domain_id: Annotated[str, Field(strict=True)], peer_domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Delete a peer domain

Removes the peering relationship with the given domain

Parameters:

domain_id (str) – (required)
peer_domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_peer_with_http_info(domain_id: Annotated[str, Field(strict=True)], peer_domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Delete a peer domain

Removes the peering relationship with the given domain

Parameters:

domain_id (str) – (required)
peer_domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_peer_without_preload_content(domain_id: Annotated[str, Field(strict=True)], peer_domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Delete a peer domain

Removes the peering relationship with the given domain

Parameters:

domain_id (str) – (required)
peer_domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_policy_rule(domain_id: Annotated[str, Field(strict=True)], rule_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Delete a domain policy rule

Delete a domain policy rule by ID

Parameters:

domain_id (str) – (required)
rule_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_policy_rule_with_http_info(domain_id: Annotated[str, Field(strict=True)], rule_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Delete a domain policy rule

Delete a domain policy rule by ID

Parameters:

domain_id (str) – (required)
rule_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_policy_rule_without_preload_content(domain_id: Annotated[str, Field(strict=True)], rule_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Delete a domain policy rule

Delete a domain policy rule by ID

Parameters:

domain_id (str) – (required)
rule_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_read_context(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Delete a read context

Delete a read context. All configuration associated with this read context will also be deleted. Domain policy rules referencing this read context will be left as-is

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_read_context_with_http_info(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Delete a read context

Delete a read context. All configuration associated with this read context will also be deleted. Domain policy rules referencing this read context will be left as-is

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_read_context_without_preload_content(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Delete a read context

Delete a read context. All configuration associated with this read context will also be deleted. Domain policy rules referencing this read context will be left as-is

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_read_context_rule(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], rule_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Delete a read context configuration rule

Deletes a read context configuration rule by ID.

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
rule_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_read_context_rule_with_http_info(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], rule_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Delete a read context configuration rule

Deletes a read context configuration rule by ID.

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
rule_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_read_context_rule_without_preload_content(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], rule_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Delete a read context configuration rule

Deletes a read context configuration rule by ID.

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
rule_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_write_context(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Delete a write context

Delete a write context. All configuration associated with this write context will also be deleted. Domain policy rules referencing this write context will be left as-is

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_write_context_with_http_info(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Delete a write context

Delete a write context. All configuration associated with this write context will also be deleted. Domain policy rules referencing this write context will be left as-is

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_write_context_without_preload_content(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Delete a write context

Delete a write context. All configuration associated with this write context will also be deleted. Domain policy rules referencing this write context will be left as-is

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_write_context_regex_rule(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], rule_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

domain_delete_write_context_regex_rule

Delete a regex classifier rule for the context

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
rule_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_write_context_regex_rule_with_http_info(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], rule_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

domain_delete_write_context_regex_rule

Delete a regex classifier rule for the context

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
rule_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_delete_write_context_regex_rule_without_preload_content(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], rule_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

domain_delete_write_context_regex_rule

Delete a regex classifier rule for the context

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
rule_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_describe_write_context(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.write_context_details.WriteContextDetails#

Describe a write context

Returns a detailed description of a write context

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_describe_write_context_with_http_info(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.write_context_details.WriteContextDetails]#

Describe a write context

Returns a detailed description of a write context

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_describe_write_context_without_preload_content(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Describe a write context

Returns a detailed description of a write context

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_external_root_encryption_key_test(domain_id: Annotated[str, Field(strict=True)], root_encryption_key_id: Annotated[str, Field(strict=True)], body: Dict[str, Any], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.root_encryption_key_test_response.RootEncryptionKeyTestResponse#

Test the health of a root encryption key

Attempts to use a root encryption key to encrypt and decrypt, validating its availability

Parameters:

domain_id (str) – (required)
root_encryption_key_id (str) – (required)
body (object) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_external_root_encryption_key_test_with_http_info(domain_id: Annotated[str, Field(strict=True)], root_encryption_key_id: Annotated[str, Field(strict=True)], body: Dict[str, Any], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.root_encryption_key_test_response.RootEncryptionKeyTestResponse]#

Test the health of a root encryption key

Attempts to use a root encryption key to encrypt and decrypt, validating its availability

Parameters:

domain_id (str) – (required)
root_encryption_key_id (str) – (required)
body (object) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_external_root_encryption_key_test_without_preload_content(domain_id: Annotated[str, Field(strict=True)], root_encryption_key_id: Annotated[str, Field(strict=True)], body: Dict[str, Any], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Test the health of a root encryption key

Attempts to use a root encryption key to encrypt and decrypt, validating its availability

Parameters:

domain_id (str) – (required)
root_encryption_key_id (str) – (required)
body (object) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_flush_encryption_keys(domain_id: Annotated[str, Field(strict=True)], body: Dict[str, Any] | None = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Flush all encryption keys

Flush all keys in memory. The keys will be immediately reloaded from persistent storage, forcing a check that the domain’s root key is still available

Parameters:

domain_id (str) – (required)
body (object) –
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_flush_encryption_keys_with_http_info(domain_id: Annotated[str, Field(strict=True)], body: Dict[str, Any] | None = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Flush all encryption keys

Flush all keys in memory. The keys will be immediately reloaded from persistent storage, forcing a check that the domain’s root key is still available

Parameters:

domain_id (str) – (required)
body (object) –
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_flush_encryption_keys_without_preload_content(domain_id: Annotated[str, Field(strict=True)], body: Dict[str, Any] | None = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Flush all encryption keys

Flush all keys in memory. The keys will be immediately reloaded from persistent storage, forcing a check that the domain’s root key is still available

Parameters:

domain_id (str) – (required)
body (object) –
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_active_external_root_encryption_key(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.root_encryption_key_item.RootEncryptionKeyItem#

Get the active root encryption key’s information.

Return the details about the current active root encryption key used by the domain ID.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_active_external_root_encryption_key_with_http_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.root_encryption_key_item.RootEncryptionKeyItem]#

Get the active root encryption key’s information.

Return the details about the current active root encryption key used by the domain ID.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_active_external_root_encryption_key_without_preload_content(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get the active root encryption key’s information.

Return the details about the current active root encryption key used by the domain ID.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_capabilities(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.capability_definition_list.CapabilityDefinitionList#

Get the domain capabilities

Get the domain capabilities. A capability is a key/value pair that can be attached to a domain identity by an identity provider. The capabilities can be referenced by the domain policy rules.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_capabilities_with_http_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.capability_definition_list.CapabilityDefinitionList]#

Get the domain capabilities

Get the domain capabilities. A capability is a key/value pair that can be attached to a domain identity by an identity provider. The capabilities can be referenced by the domain policy rules.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_capabilities_without_preload_content(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get the domain capabilities

Get the domain capabilities. A capability is a key/value pair that can be attached to a domain identity by an identity provider. The capabilities can be referenced by the domain policy rules.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_capability(domain_id: Annotated[str, Field(strict=True)], capability: Annotated[str, Field(strict=True, description='the name for this capability, like "admin"')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.capability_definition.CapabilityDefinition#

Get a single capability

Get a capability. A capability is a key/value pair that can be attached to a domain identity by an identity provider. The capabilities can be referenced by the domain policy rules.

Parameters:

domain_id (str) – (required)
capability (str) – the name for this capability, like “admin” (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_capability_with_http_info(domain_id: Annotated[str, Field(strict=True)], capability: Annotated[str, Field(strict=True, description='the name for this capability, like "admin"')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.capability_definition.CapabilityDefinition]#

Get a single capability

Get a capability. A capability is a key/value pair that can be attached to a domain identity by an identity provider. The capabilities can be referenced by the domain policy rules.

Parameters:

domain_id (str) – (required)
capability (str) – the name for this capability, like “admin” (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_capability_without_preload_content(domain_id: Annotated[str, Field(strict=True)], capability: Annotated[str, Field(strict=True, description='the name for this capability, like "admin"')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get a single capability

Get a capability. A capability is a key/value pair that can be attached to a domain identity by an identity provider. The capabilities can be referenced by the domain policy rules.

Parameters:

domain_id (str) – (required)
capability (str) – the name for this capability, like “admin” (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_capsule_info(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.capsule_info.CapsuleInfo#

Get capsule info

Get the summary information about this capsule

Parameters:

domain_id (str) – (required)
capsule_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_capsule_info_with_http_info(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.capsule_info.CapsuleInfo]#

Get capsule info

Get the summary information about this capsule

Parameters:

domain_id (str) – (required)
capsule_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_capsule_info_without_preload_content(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get capsule info

Get the summary information about this capsule

Parameters:

domain_id (str) – (required)
capsule_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_external_root_encryption_key_providers(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.available_root_encryption_key_providers.AvailableRootEncryptionKeyProviders#

Returns a list of available root encryption key providers.

Returns a list of available root encryption key providers, along with description and, if relevant, additional information required to successfully configure the external root encryption key.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_external_root_encryption_key_providers_with_http_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.available_root_encryption_key_providers.AvailableRootEncryptionKeyProviders]#

Returns a list of available root encryption key providers.

Returns a list of available root encryption key providers, along with description and, if relevant, additional information required to successfully configure the external root encryption key.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_external_root_encryption_key_providers_without_preload_content(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Returns a list of available root encryption key providers.

Returns a list of available root encryption key providers, along with description and, if relevant, additional information required to successfully configure the external root encryption key.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_fact_by_id(domain_id: Annotated[str, Field(strict=True)], fact_type: Annotated[str, Field(strict=True, description='the "type name" for this fact, like "has_role"')], fact_id: Annotated[str, Field(strict=True, description='the ID for the fact to be retrieved.')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.fact.Fact#

Get a fact by ID

Returns the fact with the given ID

Parameters:

domain_id (str) – (required)
fact_type (str) – the “type name” for this fact, like “has_role” (required)
fact_id (str) – the ID for the fact to be retrieved. (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_fact_by_id_with_http_info(domain_id: Annotated[str, Field(strict=True)], fact_type: Annotated[str, Field(strict=True, description='the "type name" for this fact, like "has_role"')], fact_id: Annotated[str, Field(strict=True, description='the ID for the fact to be retrieved.')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.fact.Fact]#

Get a fact by ID

Returns the fact with the given ID

Parameters:

domain_id (str) – (required)
fact_type (str) – the “type name” for this fact, like “has_role” (required)
fact_id (str) – the ID for the fact to be retrieved. (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_fact_by_id_without_preload_content(domain_id: Annotated[str, Field(strict=True)], fact_type: Annotated[str, Field(strict=True, description='the "type name" for this fact, like "has_role"')], fact_id: Annotated[str, Field(strict=True, description='the ID for the fact to be retrieved.')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get a fact by ID

Returns the fact with the given ID

Parameters:

domain_id (str) – (required)
fact_type (str) – the “type name” for this fact, like “has_role” (required)
fact_id (str) – the ID for the fact to be retrieved. (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_fact_type(domain_id: Annotated[str, Field(strict=True)], fact_type: Annotated[str, Field(strict=True, description='the "type name" for this fact, like "has_role"')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.fact_type_definition.FactTypeDefinition#

Get a fact type definition

Get the definition of the given fact type

Parameters:

domain_id (str) – (required)
fact_type (str) – the “type name” for this fact, like “has_role” (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_fact_type_with_http_info(domain_id: Annotated[str, Field(strict=True)], fact_type: Annotated[str, Field(strict=True, description='the "type name" for this fact, like "has_role"')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.fact_type_definition.FactTypeDefinition]#

Get a fact type definition

Get the definition of the given fact type

Parameters:

domain_id (str) – (required)
fact_type (str) – the “type name” for this fact, like “has_role” (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_fact_type_without_preload_content(domain_id: Annotated[str, Field(strict=True)], fact_type: Annotated[str, Field(strict=True, description='the "type name" for this fact, like "has_role"')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get a fact type definition

Get the definition of the given fact type

Parameters:

domain_id (str) – (required)
fact_type (str) – the “type name” for this fact, like “has_role” (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_identity_provider(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_identity_provider_info.DomainIdentityProviderInfo#

Get an identity provider’s details

Retrieve detailed information and configuration of an identity provider.

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_identity_provider_with_http_info(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_identity_provider_info.DomainIdentityProviderInfo]#

Get an identity provider’s details

Retrieve detailed information and configuration of an identity provider.

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_identity_provider_without_preload_content(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get an identity provider’s details

Retrieve detailed information and configuration of an identity provider.

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_identity_provider_principal(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], principal_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.principal_info.PrincipalInfo#

Get identity provider principal details

Retrieve detailed information about an identity provider principal.

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
principal_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_identity_provider_principal_with_http_info(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], principal_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.principal_info.PrincipalInfo]#

Get identity provider principal details

Retrieve detailed information about an identity provider principal.

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
principal_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_identity_provider_principal_without_preload_content(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], principal_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get identity provider principal details

Retrieve detailed information about an identity provider principal.

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
principal_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_identity_provider_principals(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_identity_provider_principal_list.DomainIdentityProviderPrincipalList#

Get an identity provider’s principals

Retrieve a list of principals for an identity provider

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_identity_provider_principals_with_http_info(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_identity_provider_principal_list.DomainIdentityProviderPrincipalList]#

Get an identity provider’s principals

Retrieve a list of principals for an identity provider

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_identity_provider_principals_without_preload_content(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get an identity provider’s principals

Retrieve a list of principals for an identity provider

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_peer(domain_id: Annotated[str, Field(strict=True)], nickname: pydantic.StrictStr | None = None, alias: Optional[Annotated[str, Field(strict=True)]] = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain.Domain#

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:

domain_id (str) – (required)
nickname (str) –
alias (str) –
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_peer_with_http_info(domain_id: Annotated[str, Field(strict=True)], nickname: pydantic.StrictStr | None = None, alias: Optional[Annotated[str, Field(strict=True)]] = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain.Domain]#

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:

domain_id (str) – (required)
nickname (str) –
alias (str) –
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_peer_without_preload_content(domain_id: Annotated[str, Field(strict=True)], nickname: pydantic.StrictStr | None = None, alias: Optional[Annotated[str, Field(strict=True)]] = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

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:

domain_id (str) – (required)
nickname (str) –
alias (str) –
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_peer_config(domain_id: Annotated[str, Field(strict=True)], peer_domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_peer_config.DomainPeerConfig#

Get peer configuration

Get the configuration for this peer.

Parameters:

domain_id (str) – (required)
peer_domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_peer_config_with_http_info(domain_id: Annotated[str, Field(strict=True)], peer_domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_peer_config.DomainPeerConfig]#

Get peer configuration

Get the configuration for this peer.

Parameters:

domain_id (str) – (required)
peer_domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_peer_config_without_preload_content(domain_id: Annotated[str, Field(strict=True)], peer_domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get peer configuration

Get the configuration for this peer.

Parameters:

domain_id (str) – (required)
peer_domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_private_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_private_info.DomainPrivateInfo#

Get the summary info for a Domain

Returns a Domain’s summary information.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_private_info_with_http_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_private_info.DomainPrivateInfo]#

Get the summary info for a Domain

Returns a Domain’s summary information.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_private_info_without_preload_content(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get the summary info for a Domain

Returns a Domain’s summary information.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_public_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_public_info.DomainPublicInfo#

Get the public info for a Domain

Returns a Domain’s summary information. This endpoint does not require authorization

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_public_info_with_http_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_public_info.DomainPublicInfo]#

Get the public info for a Domain

Returns a Domain’s summary information. This endpoint does not require authorization

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_public_info_without_preload_content(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get the public info for a Domain

Returns a Domain’s summary information. This endpoint does not require authorization

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_read_context(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.read_context_details.ReadContextDetails#

Get a read context

Returns information about a read context

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_read_context_with_http_info(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.read_context_details.ReadContextDetails]#

Get a read context

Returns information about a read context

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_read_context_without_preload_content(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get a read context

Returns information about a read context

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_settings(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_settings.DomainSettings#

Get the domain settings

Get the domain settings object

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_settings_with_http_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_settings.DomainSettings]#

Get the domain settings

Get the domain settings object

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_settings_without_preload_content(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get the domain settings

Get the domain settings object

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_status(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_status.DomainStatus#

Get the domain status

The domain status object contains important notifications for administrators of the domain

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_status_with_http_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_status.DomainStatus]#

Get the domain status

The domain status object contains important notifications for administrators of the domain

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_status_without_preload_content(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get the domain status

The domain status object contains important notifications for administrators of the domain

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_tag_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_tag_info_results.DomainTagInfoResults#

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 capsules there are having that tag in it.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_tag_info_with_http_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_tag_info_results.DomainTagInfoResults]#

Get an ordered list of the top 100 tags.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_tag_info_without_preload_content(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get an ordered list of the top 100 tags.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_write_context_regex_rules(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → List[antimatter.client.models.write_context_regex_rule.WriteContextRegexRule]#

domain_get_write_context_regex_rules

Get a full listing of all regex rules for the context

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_write_context_regex_rules_with_http_info(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[List[antimatter.client.models.write_context_regex_rule.WriteContextRegexRule]]#

domain_get_write_context_regex_rules

Get a full listing of all regex rules for the context

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_get_write_context_regex_rules_without_preload_content(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

domain_get_write_context_regex_rules

Get a full listing of all regex rules for the context

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_insert_identity_provider_principal(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], domain_identity_provider_principal_params: antimatter.client.models.domain_identity_provider_principal_params.DomainIdentityProviderPrincipalParams, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_insert_identity_provider_principal200_response.DomainInsertIdentityProviderPrincipal200Response#

Create a new principal for the provider

Create a new principal for the provider. Note that the identityProviderName must refer to an existing identity provider or the response will be a 400.

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
domain_identity_provider_principal_params (DomainIdentityProviderPrincipalParams) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_insert_identity_provider_principal_with_http_info(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], domain_identity_provider_principal_params: antimatter.client.models.domain_identity_provider_principal_params.DomainIdentityProviderPrincipalParams, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_insert_identity_provider_principal200_response.DomainInsertIdentityProviderPrincipal200Response]#

Create a new principal for the provider

Create a new principal for the provider. Note that the identityProviderName must refer to an existing identity provider or the response will be a 400.

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
domain_identity_provider_principal_params (DomainIdentityProviderPrincipalParams) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_insert_identity_provider_principal_without_preload_content(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], domain_identity_provider_principal_params: antimatter.client.models.domain_identity_provider_principal_params.DomainIdentityProviderPrincipalParams, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Create a new principal for the provider

Create a new principal for the provider. Note that the identityProviderName must refer to an existing identity provider or the response will be a 400.

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
domain_identity_provider_principal_params (DomainIdentityProviderPrincipalParams) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_insert_write_context_regex_rule(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], write_context_regex_rule: antimatter.client.models.write_context_regex_rule.WriteContextRegexRule, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_insert_write_context_regex_rule200_response.DomainInsertWriteContextRegexRule200Response#

Insert a write context regex rule

Create a new regex rule for a write context.

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
write_context_regex_rule (WriteContextRegexRule) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_insert_write_context_regex_rule_with_http_info(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], write_context_regex_rule: antimatter.client.models.write_context_regex_rule.WriteContextRegexRule, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_insert_write_context_regex_rule200_response.DomainInsertWriteContextRegexRule200Response]#

Insert a write context regex rule

Create a new regex rule for a write context.

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
write_context_regex_rule (WriteContextRegexRule) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_insert_write_context_regex_rule_without_preload_content(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], write_context_regex_rule: antimatter.client.models.write_context_regex_rule.WriteContextRegexRule, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Insert a write context regex rule

Create a new regex rule for a write context.

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
write_context_regex_rule (WriteContextRegexRule) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_capsules(domain_id: Annotated[str, Field(strict=True)], start_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, end_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, num_results: Annotated[Optional[Annotated[int, Field(le=2000, strict=True, ge=10)]], Field(description='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. ')] = None, span_tags: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, sort_on: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, start_after: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, ascending: Annotated[Optional[pydantic.StrictBool], Field(description='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. ')] = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.capsule_list.CapsuleList#

Get capsule list

Get information about capsules

Parameters:

domain_id (str) – (required)
start_date (datetime) – 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.
end_date (datetime) – 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 (int) – 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.
span_tags (str) – 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 (str) – 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 (str) – 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 (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.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_capsules_with_http_info(domain_id: Annotated[str, Field(strict=True)], start_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, end_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, num_results: Annotated[Optional[Annotated[int, Field(le=2000, strict=True, ge=10)]], Field(description='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. ')] = None, span_tags: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, sort_on: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, start_after: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, ascending: Annotated[Optional[pydantic.StrictBool], Field(description='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. ')] = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.capsule_list.CapsuleList]#

Get capsule list

Get information about capsules

Parameters:

domain_id (str) – (required)
start_date (datetime) – 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.
end_date (datetime) – 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 (int) – 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.
span_tags (str) – 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 (str) – 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 (str) – 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 (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.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_capsules_without_preload_content(domain_id: Annotated[str, Field(strict=True)], start_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, end_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, num_results: Annotated[Optional[Annotated[int, Field(le=2000, strict=True, ge=10)]], Field(description='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. ')] = None, span_tags: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, sort_on: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, start_after: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, ascending: Annotated[Optional[pydantic.StrictBool], Field(description='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. ')] = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get capsule list

Get information about capsules

Parameters:

domain_id (str) – (required)
start_date (datetime) – 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.
end_date (datetime) – 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 (int) – 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.
span_tags (str) – 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 (str) – 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 (str) – 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 (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.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_external_root_encryption_key(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → List[antimatter.client.models.root_encryption_key_item.RootEncryptionKeyItem]#

List all external root encryption keys.

List all external root encryption keys for the domain.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_external_root_encryption_key_with_http_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[List[antimatter.client.models.root_encryption_key_item.RootEncryptionKeyItem]]#

List all external root encryption keys.

List all external root encryption keys for the domain.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_external_root_encryption_key_without_preload_content(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

List all external root encryption keys.

List all external root encryption keys for the domain.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_fact_types(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_fact_list.DomainFactList#

List the domain’s fact types

Get a list of the registered fact types in this domain

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_fact_types_with_http_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_fact_list.DomainFactList]#

List the domain’s fact types

Get a list of the registered fact types in this domain

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_fact_types_without_preload_content(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

List the domain’s fact types

Get a list of the registered fact types in this domain

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_facts(domain_id: Annotated[str, Field(strict=True)], fact_type: Annotated[str, Field(strict=True, description='the "type name" for this fact, like "has_role"')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.fact_list.FactList#

Get facts for a type

Get the facts corresponding to a fact type

Parameters:

domain_id (str) – (required)
fact_type (str) – the “type name” for this fact, like “has_role” (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_facts_with_http_info(domain_id: Annotated[str, Field(strict=True)], fact_type: Annotated[str, Field(strict=True, description='the "type name" for this fact, like "has_role"')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.fact_list.FactList]#

Get facts for a type

Get the facts corresponding to a fact type

Parameters:

domain_id (str) – (required)
fact_type (str) – the “type name” for this fact, like “has_role” (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_facts_without_preload_content(domain_id: Annotated[str, Field(strict=True)], fact_type: Annotated[str, Field(strict=True, description='the "type name" for this fact, like "has_role"')], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get facts for a type

Get the facts corresponding to a fact type

Parameters:

domain_id (str) – (required)
fact_type (str) – the “type name” for this fact, like “has_role” (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_hooks(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_hooks_list.DomainHooksList#

Lists available hooks

Get a list of available hooks in this domain. A hook is a data processor, like a PII classifier

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_hooks_with_http_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_hooks_list.DomainHooksList]#

Lists available hooks

Get a list of available hooks in this domain. A hook is a data processor, like a PII classifier

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_hooks_without_preload_content(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Lists available hooks

Get a list of available hooks in this domain. A hook is a data processor, like a PII classifier

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_identity_providers(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_identity_provider_list.DomainIdentityProviderList#

Get a summary of the domain’s Identity Providers

Retrieve the domain’s identity providers and a brief overview of their configuration

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_identity_providers_with_http_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_identity_provider_list.DomainIdentityProviderList]#

Get a summary of the domain’s Identity Providers

Retrieve the domain’s identity providers and a brief overview of their configuration

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_identity_providers_without_preload_content(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get a summary of the domain’s Identity Providers

Retrieve the domain’s identity providers and a brief overview of their configuration

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_peers(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_peer_list.DomainPeerList#

List domain peers

Returns a list of this domains peers

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_peers_with_http_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_peer_list.DomainPeerList]#

List domain peers

Returns a list of this domains peers

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_peers_without_preload_content(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

List domain peers

Returns a list of this domains peers

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_policy_rules(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_policy.DomainPolicy#

Get the domain policy rules

Get the domain policy rules. These govern which resources in the domain can be interacted with. Note that the peers “bypass” these rules, in that a peer domain can retrieve policy and configuration that has been allowed by peering configuration without needing an allowing domain policy rule, but they cannot access data within this domain.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_policy_rules_with_http_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_policy.DomainPolicy]#

Get the domain policy rules

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_policy_rules_without_preload_content(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get the domain policy rules

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_read_contexts(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.read_context_list.ReadContextList#

List domain read contexts

List the domain read contexts. If a user has view permissions on this resource, they may list all read contexts, even if they do not have view, edit or use permissions on some of the read contexts in the list.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_read_contexts_with_http_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.read_context_list.ReadContextList]#

List domain read contexts

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_read_contexts_without_preload_content(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

List domain read contexts

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_resources(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_resource_summary.DomainResourceSummary#

Get a summary of access control resource paths

Gets a list of resource strings that can be used in policy rules, and the set of permissions that you can assign to them

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_resources_with_http_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_resource_summary.DomainResourceSummary]#

Get a summary of access control resource paths

Gets a list of resource strings that can be used in policy rules, and the set of permissions that you can assign to them

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_resources_without_preload_content(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get a summary of access control resource paths

Gets a list of resource strings that can be used in policy rules, and the set of permissions that you can assign to them

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_write_contexts(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.write_context_list.WriteContextList#

List domain write contexts

List the domain write contexts. If a user has view permissions on this resource, they may list all write contexts, even if they do not have view, edit or use permissions on some of the write contexts in the list.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_write_contexts_with_http_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.write_context_list.WriteContextList]#

List domain write contexts

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_list_write_contexts_without_preload_content(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

List domain write contexts

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_open_capsule(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], read_context: Annotated[str, Field(strict=True)], capsule_open_request: antimatter.client.models.capsule_open_request.CapsuleOpenRequest, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.capsule_open_response.CapsuleOpenResponse#

Open a capsule for reading

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

Parameters:

domain_id (str) – (required)
capsule_id (str) – (required)
read_context (str) – (required)
capsule_open_request (CapsuleOpenRequest) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_open_capsule_with_http_info(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], read_context: Annotated[str, Field(strict=True)], capsule_open_request: antimatter.client.models.capsule_open_request.CapsuleOpenRequest, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.capsule_open_response.CapsuleOpenResponse]#

Open a capsule for reading

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

Parameters:

domain_id (str) – (required)
capsule_id (str) – (required)
read_context (str) – (required)
capsule_open_request (CapsuleOpenRequest) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_open_capsule_without_preload_content(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], read_context: Annotated[str, Field(strict=True)], capsule_open_request: antimatter.client.models.capsule_open_request.CapsuleOpenRequest, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Open a capsule for reading

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

Parameters:

domain_id (str) – (required)
capsule_id (str) – (required)
read_context (str) – (required)
capsule_open_request (CapsuleOpenRequest) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_patch_settings(domain_id: Annotated[str, Field(strict=True)], domain_settings_patch: antimatter.client.models.domain_settings_patch.DomainSettingsPatch, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_settings.DomainSettings#

Update the domain settings

Applies the given patch to the domain settings. The user must have permissions on all resources the patch references

Parameters:

domain_id (str) – (required)
domain_settings_patch (DomainSettingsPatch) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_patch_settings_with_http_info(domain_id: Annotated[str, Field(strict=True)], domain_settings_patch: antimatter.client.models.domain_settings_patch.DomainSettingsPatch, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_settings.DomainSettings]#

Update the domain settings

Applies the given patch to the domain settings. The user must have permissions on all resources the patch references

Parameters:

domain_id (str) – (required)
domain_settings_patch (DomainSettingsPatch) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_patch_settings_without_preload_content(domain_id: Annotated[str, Field(strict=True)], domain_settings_patch: antimatter.client.models.domain_settings_patch.DomainSettingsPatch, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Update the domain settings

Applies the given patch to the domain settings. The user must have permissions on all resources the patch references

Parameters:

domain_id (str) – (required)
domain_settings_patch (DomainSettingsPatch) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_policy_flush(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Flush the policy cache

Flush the policy cache so that changes to permissions take effect

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_policy_flush_with_http_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Flush the policy cache

Flush the policy cache so that changes to permissions take effect

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_policy_flush_without_preload_content(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Flush the policy cache

Flush the policy cache so that changes to permissions take effect

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_put_capability(domain_id: Annotated[str, Field(strict=True)], capability: Annotated[str, Field(strict=True, description='the name for this capability, like "admin"')], new_capability_definition: antimatter.client.models.new_capability_definition.NewCapabilityDefinition, createonly: Annotated[Optional[pydantic.StrictBool], Field(description='return an error if the capability already existed')] = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Create or update a capability

Create or update a capability. If you want to return an error if the capability already existed, set createonly=true

Parameters:

domain_id (str) – (required)
capability (str) – the name for this capability, like “admin” (required)
new_capability_definition (NewCapabilityDefinition) – (required)
createonly (bool) – return an error if the capability already existed
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_put_capability_with_http_info(domain_id: Annotated[str, Field(strict=True)], capability: Annotated[str, Field(strict=True, description='the name for this capability, like "admin"')], new_capability_definition: antimatter.client.models.new_capability_definition.NewCapabilityDefinition, createonly: Annotated[Optional[pydantic.StrictBool], Field(description='return an error if the capability already existed')] = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Create or update a capability

Create or update a capability. If you want to return an error if the capability already existed, set createonly=true

Parameters:

domain_id (str) – (required)
capability (str) – the name for this capability, like “admin” (required)
new_capability_definition (NewCapabilityDefinition) – (required)
createonly (bool) – return an error if the capability already existed
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_put_capability_without_preload_content(domain_id: Annotated[str, Field(strict=True)], capability: Annotated[str, Field(strict=True, description='the name for this capability, like "admin"')], new_capability_definition: antimatter.client.models.new_capability_definition.NewCapabilityDefinition, createonly: Annotated[Optional[pydantic.StrictBool], Field(description='return an error if the capability already existed')] = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Create or update a capability

Create or update a capability. If you want to return an error if the capability already existed, set createonly=true

Parameters:

domain_id (str) – (required)
capability (str) – the name for this capability, like “admin” (required)
new_capability_definition (NewCapabilityDefinition) – (required)
createonly (bool) – return an error if the capability already existed
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_put_fact_type(domain_id: Annotated[str, Field(strict=True)], fact_type: Annotated[str, Field(strict=True, description='the "type name" for this fact, like "has_role"')], new_fact_type_definition: antimatter.client.models.new_fact_type_definition.NewFactTypeDefinition, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Create a fact type

Facts are used to store ancillary information that helps express domain policy rules and read context configuration rules. This endpoint allows you to register a new fact type. To create a fact of a given type, use /domains/{domainID}/control/facts/{factType}/new

Parameters:

domain_id (str) – (required)
fact_type (str) – the “type name” for this fact, like “has_role” (required)
new_fact_type_definition (NewFactTypeDefinition) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_put_fact_type_with_http_info(domain_id: Annotated[str, Field(strict=True)], fact_type: Annotated[str, Field(strict=True, description='the "type name" for this fact, like "has_role"')], new_fact_type_definition: antimatter.client.models.new_fact_type_definition.NewFactTypeDefinition, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Create a fact type

Parameters:

domain_id (str) – (required)
fact_type (str) – the “type name” for this fact, like “has_role” (required)
new_fact_type_definition (NewFactTypeDefinition) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_put_fact_type_without_preload_content(domain_id: Annotated[str, Field(strict=True)], fact_type: Annotated[str, Field(strict=True, description='the "type name" for this fact, like "has_role"')], new_fact_type_definition: antimatter.client.models.new_fact_type_definition.NewFactTypeDefinition, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Create a fact type

Parameters:

domain_id (str) – (required)
fact_type (str) – the “type name” for this fact, like “has_role” (required)
new_fact_type_definition (NewFactTypeDefinition) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_query_access_log(domain_id: Annotated[str, Field(strict=True)], start_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, end_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, num_results: Annotated[Optional[Annotated[int, Field(le=2000, strict=True, ge=10)]], Field(description='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. ')] = None, start_from_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description='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. ')] = None, session: Annotated[Optional[pydantic.StrictStr], Field(description='the session you would like to filter on. This will return results for only the provided session. If not specified, this field is ignored. ')] = None, location: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, location_prefixed: Annotated[Optional[pydantic.StrictBool], Field(description='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. ')] = None, operation_type: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, allowed_tag: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description='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. ')] = None, redacted_or_tokenized_tag: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description='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. ')] = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.access_log_results.AccessLogResults#

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:

domain_id (str) – (required)
start_date (datetime) – 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.
end_date (datetime) – 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 (int) – 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.
start_from_id (str) – 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 (str) – 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 (str) – 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 (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 (str) – 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 (str) – 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 (str) – 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.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_query_access_log_with_http_info(domain_id: Annotated[str, Field(strict=True)], start_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, end_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, num_results: Annotated[Optional[Annotated[int, Field(le=2000, strict=True, ge=10)]], Field(description='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. ')] = None, start_from_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description='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. ')] = None, session: Annotated[Optional[pydantic.StrictStr], Field(description='the session you would like to filter on. This will return results for only the provided session. If not specified, this field is ignored. ')] = None, location: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, location_prefixed: Annotated[Optional[pydantic.StrictBool], Field(description='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. ')] = None, operation_type: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, allowed_tag: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description='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. ')] = None, redacted_or_tokenized_tag: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description='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. ')] = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.access_log_results.AccessLogResults]#

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:

domain_id (str) – (required)
start_date (datetime) – 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.
end_date (datetime) – 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 (int) – 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.
start_from_id (str) – 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 (str) – 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 (str) – 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 (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 (str) – 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 (str) – 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 (str) – 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.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_query_access_log_without_preload_content(domain_id: Annotated[str, Field(strict=True)], start_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, end_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, num_results: Annotated[Optional[Annotated[int, Field(le=2000, strict=True, ge=10)]], Field(description='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. ')] = None, start_from_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description='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. ')] = None, session: Annotated[Optional[pydantic.StrictStr], Field(description='the session you would like to filter on. This will return results for only the provided session. If not specified, this field is ignored. ')] = None, location: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, location_prefixed: Annotated[Optional[pydantic.StrictBool], Field(description='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. ')] = None, operation_type: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, allowed_tag: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description='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. ')] = None, redacted_or_tokenized_tag: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description='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. ')] = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

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:

domain_id (str) – (required)
start_date (datetime) – 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.
end_date (datetime) – 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 (int) – 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.
start_from_id (str) – 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 (str) – 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 (str) – 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 (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 (str) – 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 (str) – 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 (str) – 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.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_query_access_log_single_capsule(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], start_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, end_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, num_results: Annotated[Optional[Annotated[int, Field(le=2000, strict=True, ge=10)]], Field(description='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. ')] = None, start_from_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description='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. ')] = None, session: Annotated[Optional[pydantic.StrictStr], Field(description='the session you would like to filter on. This will return results for only the provided session. If not specified, this field is ignored. ')] = None, location: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, location_prefixed: Annotated[Optional[pydantic.StrictBool], Field(description='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. ')] = None, operation_type: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, allowed_tag: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description='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. ')] = None, redacted_or_tokenized_tag: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description='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. ')] = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.access_log_results.AccessLogResults#

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:

domain_id (str) – (required)
capsule_id (str) – (required)
start_date (datetime) – 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.
end_date (datetime) – 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 (int) – 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.
start_from_id (str) – 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 (str) – 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 (str) – 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 (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 (str) – 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 (str) – 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 (str) – 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.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_query_access_log_single_capsule_with_http_info(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], start_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, end_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, num_results: Annotated[Optional[Annotated[int, Field(le=2000, strict=True, ge=10)]], Field(description='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. ')] = None, start_from_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description='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. ')] = None, session: Annotated[Optional[pydantic.StrictStr], Field(description='the session you would like to filter on. This will return results for only the provided session. If not specified, this field is ignored. ')] = None, location: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, location_prefixed: Annotated[Optional[pydantic.StrictBool], Field(description='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. ')] = None, operation_type: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, allowed_tag: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description='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. ')] = None, redacted_or_tokenized_tag: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description='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. ')] = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.access_log_results.AccessLogResults]#

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:

domain_id (str) – (required)
capsule_id (str) – (required)
start_date (datetime) – 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.
end_date (datetime) – 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 (int) – 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.
start_from_id (str) – 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 (str) – 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 (str) – 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 (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 (str) – 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 (str) – 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 (str) – 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.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_query_access_log_single_capsule_without_preload_content(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], start_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, end_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, num_results: Annotated[Optional[Annotated[int, Field(le=2000, strict=True, ge=10)]], Field(description='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. ')] = None, start_from_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description='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. ')] = None, session: Annotated[Optional[pydantic.StrictStr], Field(description='the session you would like to filter on. This will return results for only the provided session. If not specified, this field is ignored. ')] = None, location: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, location_prefixed: Annotated[Optional[pydantic.StrictBool], Field(description='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. ')] = None, operation_type: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, allowed_tag: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description='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. ')] = None, redacted_or_tokenized_tag: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description='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. ')] = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

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:

domain_id (str) – (required)
capsule_id (str) – (required)
start_date (datetime) – 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.
end_date (datetime) – 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 (int) – 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.
start_from_id (str) – 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 (str) – 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 (str) – 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 (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 (str) – 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 (str) – 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 (str) – 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.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_query_control_log(domain_id: Annotated[str, Field(strict=True)], start_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, end_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, num_results: Annotated[Optional[Annotated[int, Field(le=2000, strict=True, ge=10)]], Field(description='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. ')] = None, start_from_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description='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. ')] = None, session: Annotated[Optional[pydantic.StrictStr], Field(description='the session you would like to filter on. This will return results for only the provided session. If not specified, this field is ignored. ')] = None, url: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, description: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_control_log_results.DomainControlLogResults#

Get the domain control-plane audit log

Query the domain control-plane audit log. Results are returned in reverse chronological order

Parameters:

domain_id (str) – (required)
start_date (datetime) – 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.
end_date (datetime) – 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 (int) – 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.
start_from_id (str) – 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 (str) – 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 (str) – 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 (str) – 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.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_query_control_log_with_http_info(domain_id: Annotated[str, Field(strict=True)], start_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, end_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, num_results: Annotated[Optional[Annotated[int, Field(le=2000, strict=True, ge=10)]], Field(description='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. ')] = None, start_from_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description='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. ')] = None, session: Annotated[Optional[pydantic.StrictStr], Field(description='the session you would like to filter on. This will return results for only the provided session. If not specified, this field is ignored. ')] = None, url: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, description: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_control_log_results.DomainControlLogResults]#

Get the domain control-plane audit log

Query the domain control-plane audit log. Results are returned in reverse chronological order

Parameters:

domain_id (str) – (required)
start_date (datetime) – 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.
end_date (datetime) – 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 (int) – 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.
start_from_id (str) – 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 (str) – 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 (str) – 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 (str) – 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.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_query_control_log_without_preload_content(domain_id: Annotated[str, Field(strict=True)], start_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, end_date: Annotated[Optional[datetime.datetime], Field(description='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. ')] = None, num_results: Annotated[Optional[Annotated[int, Field(le=2000, strict=True, ge=10)]], Field(description='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. ')] = None, start_from_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description='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. ')] = None, session: Annotated[Optional[pydantic.StrictStr], Field(description='the session you would like to filter on. This will return results for only the provided session. If not specified, this field is ignored. ')] = None, url: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, description: Annotated[Optional[pydantic.StrictStr], Field(description='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. ')] = None, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Get the domain control-plane audit log

Query the domain control-plane audit log. Results are returned in reverse chronological order

Parameters:

domain_id (str) – (required)
start_date (datetime) – 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.
end_date (datetime) – 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 (int) – 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.
start_from_id (str) – 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 (str) – 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 (str) – 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 (str) – 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.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_renumber_policy_rules(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_policy.DomainPolicy#

Re-assign rule numbers

Re-assign rule priority numbers to integer multiples of 10

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_renumber_policy_rules_with_http_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_policy.DomainPolicy]#

Re-assign rule numbers

Re-assign rule priority numbers to integer multiples of 10

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_renumber_policy_rules_without_preload_content(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Re-assign rule numbers

Re-assign rule priority numbers to integer multiples of 10

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_rotate_root_encryption_keys(domain_id: Annotated[str, Field(strict=True)], body: Dict[str, Any], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.rotate_key_encryption_key_response.RotateKeyEncryptionKeyResponse#

Re-encrypt key encryption keys with active root encryption key.

Collects key encryption keys not encrypted with the current active root encryption key, decrypts them with their original root encryption key, and then encrypts them with root encryption key. This is a batched operation and “has_more” will indicate whether there more key encryption keys that can be rotated.

Parameters:

domain_id (str) – (required)
body (object) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_rotate_root_encryption_keys_with_http_info(domain_id: Annotated[str, Field(strict=True)], body: Dict[str, Any], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.rotate_key_encryption_key_response.RotateKeyEncryptionKeyResponse]#

Re-encrypt key encryption keys with active root encryption key.

Parameters:

domain_id (str) – (required)
body (object) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_rotate_root_encryption_keys_without_preload_content(domain_id: Annotated[str, Field(strict=True)], body: Dict[str, Any], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Re-encrypt key encryption keys with active root encryption key.

Parameters:

domain_id (str) – (required)
body (object) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_seal_capsule(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], capsule_seal_request: antimatter.client.models.capsule_seal_request.CapsuleSealRequest, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Seal a capsule

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

Parameters:

domain_id (str) – (required)
capsule_id (str) – (required)
capsule_seal_request (CapsuleSealRequest) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_seal_capsule_with_http_info(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], capsule_seal_request: antimatter.client.models.capsule_seal_request.CapsuleSealRequest, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Seal a capsule

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

Parameters:

domain_id (str) – (required)
capsule_id (str) – (required)
capsule_seal_request (CapsuleSealRequest) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_seal_capsule_without_preload_content(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], capsule_seal_request: antimatter.client.models.capsule_seal_request.CapsuleSealRequest, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Seal a capsule

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

Parameters:

domain_id (str) – (required)
capsule_id (str) – (required)
capsule_seal_request (CapsuleSealRequest) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_set_active_external_root_encryption_key(domain_id: Annotated[str, Field(strict=True)], active_root_encryption_key_id: antimatter.client.models.active_root_encryption_key_id.ActiveRootEncryptionKeyID, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Set the root encryption key ID that should be used.

This will update the active root encryption key for a domain that should be used for root encryption key cryptographic operations.

Parameters:

domain_id (str) – (required)
active_root_encryption_key_id (ActiveRootEncryptionKeyID) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_set_active_external_root_encryption_key_with_http_info(domain_id: Annotated[str, Field(strict=True)], active_root_encryption_key_id: antimatter.client.models.active_root_encryption_key_id.ActiveRootEncryptionKeyID, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Set the root encryption key ID that should be used.

This will update the active root encryption key for a domain that should be used for root encryption key cryptographic operations.

Parameters:

domain_id (str) – (required)
active_root_encryption_key_id (ActiveRootEncryptionKeyID) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_set_active_external_root_encryption_key_without_preload_content(domain_id: Annotated[str, Field(strict=True)], active_root_encryption_key_id: antimatter.client.models.active_root_encryption_key_id.ActiveRootEncryptionKeyID, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Set the root encryption key ID that should be used.

This will update the active root encryption key for a domain that should be used for root encryption key cryptographic operations.

Parameters:

domain_id (str) – (required)
active_root_encryption_key_id (ActiveRootEncryptionKeyID) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_update_identity_provider_principal(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], principal_id: Annotated[str, Field(strict=True)], capability_list: antimatter.client.models.capability_list.CapabilityList, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Update identity provider principal capabilities

Update capabilities for an identity provider principal.

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
principal_id (str) – (required)
capability_list (CapabilityList) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_update_identity_provider_principal_with_http_info(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], principal_id: Annotated[str, Field(strict=True)], capability_list: antimatter.client.models.capability_list.CapabilityList, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Update identity provider principal capabilities

Update capabilities for an identity provider principal.

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
principal_id (str) – (required)
capability_list (CapabilityList) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_update_identity_provider_principal_without_preload_content(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], principal_id: Annotated[str, Field(strict=True)], capability_list: antimatter.client.models.capability_list.CapabilityList, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Update identity provider principal capabilities

Update capabilities for an identity provider principal.

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
principal_id (str) – (required)
capability_list (CapabilityList) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_update_peer(domain_id: Annotated[str, Field(strict=True)], peer_domain_id: Annotated[str, Field(strict=True)], domain_peer_config: antimatter.client.models.domain_peer_config.DomainPeerConfig, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

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:

domain_id (str) – (required)
peer_domain_id (str) – (required)
domain_peer_config (DomainPeerConfig) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_update_peer_with_http_info(domain_id: Annotated[str, Field(strict=True)], peer_domain_id: Annotated[str, Field(strict=True)], domain_peer_config: antimatter.client.models.domain_peer_config.DomainPeerConfig, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Update peer configuration

Parameters:

domain_id (str) – (required)
peer_domain_id (str) – (required)
domain_peer_config (DomainPeerConfig) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_update_peer_without_preload_content(domain_id: Annotated[str, Field(strict=True)], peer_domain_id: Annotated[str, Field(strict=True)], domain_peer_config: antimatter.client.models.domain_peer_config.DomainPeerConfig, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Update peer configuration

Parameters:

domain_id (str) – (required)
peer_domain_id (str) – (required)
domain_peer_config (DomainPeerConfig) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_update_policy_rule(domain_id: Annotated[str, Field(strict=True)], rule_id: Annotated[str, Field(strict=True)], domain_policy_rule: antimatter.client.models.domain_policy_rule.DomainPolicyRule, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Update a domain policy rule

Parameters:

domain_id (str) – (required)
rule_id (str) – (required)
domain_policy_rule (DomainPolicyRule) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_update_policy_rule_with_http_info(domain_id: Annotated[str, Field(strict=True)], rule_id: Annotated[str, Field(strict=True)], domain_policy_rule: antimatter.client.models.domain_policy_rule.DomainPolicyRule, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Update a domain policy rule

Parameters:

domain_id (str) – (required)
rule_id (str) – (required)
domain_policy_rule (DomainPolicyRule) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_update_policy_rule_without_preload_content(domain_id: Annotated[str, Field(strict=True)], rule_id: Annotated[str, Field(strict=True)], domain_policy_rule: antimatter.client.models.domain_policy_rule.DomainPolicyRule, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Update a domain policy rule

Parameters:

domain_id (str) – (required)
rule_id (str) – (required)
domain_policy_rule (DomainPolicyRule) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_update_read_context_rule(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], rule_id: Annotated[str, Field(strict=True)], new_read_context_config_rule: antimatter.client.models.new_read_context_config_rule.NewReadContextConfigRule, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Update a read context configuration rule

Update a read context configuration rule. The rule must already exist

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
rule_id (str) – (required)
new_read_context_config_rule (NewReadContextConfigRule) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_update_read_context_rule_with_http_info(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], rule_id: Annotated[str, Field(strict=True)], new_read_context_config_rule: antimatter.client.models.new_read_context_config_rule.NewReadContextConfigRule, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Update a read context configuration rule

Update a read context configuration rule. The rule must already exist

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
rule_id (str) – (required)
new_read_context_config_rule (NewReadContextConfigRule) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_update_read_context_rule_without_preload_content(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], rule_id: Annotated[str, Field(strict=True)], new_read_context_config_rule: antimatter.client.models.new_read_context_config_rule.NewReadContextConfigRule, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Update a read context configuration rule

Update a read context configuration rule. The rule must already exist

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
rule_id (str) – (required)
new_read_context_config_rule (NewReadContextConfigRule) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_upsert_capsule_tags(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], tag: List[antimatter.client.models.tag.Tag], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Upsert capsule-scope tags

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

Parameters:

domain_id (str) – (required)
capsule_id (str) – (required)
tag (List[Tag]) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_upsert_capsule_tags_with_http_info(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], tag: List[antimatter.client.models.tag.Tag], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Upsert capsule-scope tags

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

Parameters:

domain_id (str) – (required)
capsule_id (str) – (required)
tag (List[Tag]) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_upsert_capsule_tags_without_preload_content(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], tag: List[antimatter.client.models.tag.Tag], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Upsert capsule-scope tags

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

Parameters:

domain_id (str) – (required)
capsule_id (str) – (required)
tag (List[Tag]) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_upsert_fact(domain_id: Annotated[str, Field(strict=True)], fact_type: Annotated[str, Field(strict=True, description='the "type name" for this fact, like "has_role"')], new_fact: antimatter.client.models.new_fact.NewFact, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.fact.Fact#

Upsert a fact

Create a new fact. The fact type must have been previously registered using /domains/{domainID}/control/facts/{factType}. If an identical fact exists (having the same value for all fields), this call is a no-op

Parameters:

domain_id (str) – (required)
fact_type (str) – the “type name” for this fact, like “has_role” (required)
new_fact (NewFact) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_upsert_fact_with_http_info(domain_id: Annotated[str, Field(strict=True)], fact_type: Annotated[str, Field(strict=True, description='the "type name" for this fact, like "has_role"')], new_fact: antimatter.client.models.new_fact.NewFact, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.fact.Fact]#

Upsert a fact

Parameters:

domain_id (str) – (required)
fact_type (str) – the “type name” for this fact, like “has_role” (required)
new_fact (NewFact) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_upsert_fact_without_preload_content(domain_id: Annotated[str, Field(strict=True)], fact_type: Annotated[str, Field(strict=True, description='the "type name" for this fact, like "has_role"')], new_fact: antimatter.client.models.new_fact.NewFact, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Upsert a fact

Parameters:

domain_id (str) – (required)
fact_type (str) – the “type name” for this fact, like “has_role” (required)
new_fact (NewFact) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_upsert_identity_provider(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], domain_identity_provider_details: antimatter.client.models.domain_identity_provider_details.DomainIdentityProviderDetails, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.domain_identity_provider_info.DomainIdentityProviderInfo#

Create/Update an identity provider

Create or configure an identity provider.

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
domain_identity_provider_details (DomainIdentityProviderDetails) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_upsert_identity_provider_with_http_info(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], domain_identity_provider_details: antimatter.client.models.domain_identity_provider_details.DomainIdentityProviderDetails, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.domain_identity_provider_info.DomainIdentityProviderInfo]#

Create/Update an identity provider

Create or configure an identity provider.

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
domain_identity_provider_details (DomainIdentityProviderDetails) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_upsert_identity_provider_without_preload_content(domain_id: Annotated[str, Field(strict=True)], identity_provider_name: Annotated[str, Field(strict=True)], domain_identity_provider_details: antimatter.client.models.domain_identity_provider_details.DomainIdentityProviderDetails, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Create/Update an identity provider

Create or configure an identity provider.

Parameters:

domain_id (str) – (required)
identity_provider_name (str) – (required)
domain_identity_provider_details (DomainIdentityProviderDetails) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_upsert_read_context(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], add_read_context: antimatter.client.models.add_read_context.AddReadContext, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Update or create a read context

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
add_read_context (AddReadContext) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_upsert_read_context_with_http_info(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], add_read_context: antimatter.client.models.add_read_context.AddReadContext, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Update or create a read context

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
add_read_context (AddReadContext) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_upsert_read_context_without_preload_content(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], add_read_context: antimatter.client.models.add_read_context.AddReadContext, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Update or create a read context

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
add_read_context (AddReadContext) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_upsert_span_tags(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], upsert_span_tags_request: antimatter.client.models.upsert_span_tags_request.UpsertSpanTagsRequest, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

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:

domain_id (str) – (required)
capsule_id (str) – (required)
upsert_span_tags_request (UpsertSpanTagsRequest) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_upsert_span_tags_with_http_info(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], upsert_span_tags_request: antimatter.client.models.upsert_span_tags_request.UpsertSpanTagsRequest, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Upsert span-scope tags

Parameters:

domain_id (str) – (required)
capsule_id (str) – (required)
upsert_span_tags_request (UpsertSpanTagsRequest) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_upsert_span_tags_without_preload_content(domain_id: Annotated[str, Field(strict=True)], capsule_id: Annotated[str, Field(strict=True)], upsert_span_tags_request: antimatter.client.models.upsert_span_tags_request.UpsertSpanTagsRequest, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Upsert span-scope tags

Parameters:

domain_id (str) – (required)
capsule_id (str) – (required)
upsert_span_tags_request (UpsertSpanTagsRequest) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_upsert_write_context(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], add_write_context: antimatter.client.models.add_write_context.AddWriteContext, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Upsert a write context

Create or update an existing write context. If the config is omitted, it will be left as-is (existing write contexts) or created as blank (new write contexts)

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
add_write_context (AddWriteContext) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_upsert_write_context_with_http_info(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], add_write_context: antimatter.client.models.add_write_context.AddWriteContext, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Upsert a write context

Create or update an existing write context. If the config is omitted, it will be left as-is (existing write contexts) or created as blank (new write contexts)

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
add_write_context (AddWriteContext) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_upsert_write_context_without_preload_content(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], add_write_context: antimatter.client.models.add_write_context.AddWriteContext, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Upsert a write context

Create or update an existing write context. If the config is omitted, it will be left as-is (existing write contexts) or created as blank (new write contexts)

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
add_write_context (AddWriteContext) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_upsert_write_context_configuration(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], write_context_config_info: antimatter.client.models.write_context_config_info.WriteContextConfigInfo, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Update a write context configuration

Update a write context configuration. The write context must already exist.

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
write_context_config_info (WriteContextConfigInfo) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_upsert_write_context_configuration_with_http_info(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], write_context_config_info: antimatter.client.models.write_context_config_info.WriteContextConfigInfo, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Update a write context configuration

Update a write context configuration. The write context must already exist.

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
write_context_config_info (WriteContextConfigInfo) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

domain_upsert_write_context_configuration_without_preload_content(domain_id: Annotated[str, Field(strict=True)], context_name: Annotated[str, Field(strict=True)], write_context_config_info: antimatter.client.models.write_context_config_info.WriteContextConfigInfo, _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Update a write context configuration

Update a write context configuration. The write context must already exist.

Parameters:

domain_id (str) – (required)
context_name (str) – (required)
write_context_config_info (WriteContextConfigInfo) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

starred_domain_add(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Adds to starred domains

Adds the domain to the list of starred domains for the user.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

starred_domain_add_with_http_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Adds to starred domains

Adds the domain to the list of starred domains for the user.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

starred_domain_add_without_preload_content(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Adds to starred domains

Adds the domain to the list of starred domains for the user.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

starred_domain_list(_request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.models.starred_domain_list.StarredDomainList#

List the user’s starred domains

Returns a list of domains that the user has starred. This is a list of domain IDs, not domain names. The user must be authenticated to call this method.

Parameters:

_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

starred_domain_list_with_http_info(_request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[antimatter.client.models.starred_domain_list.StarredDomainList]#

List the user’s starred domains

Returns a list of domains that the user has starred. This is a list of domain IDs, not domain names. The user must be authenticated to call this method.

Parameters:

_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

starred_domain_list_without_preload_content(_request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

List the user’s starred domains

Returns a list of domains that the user has starred. This is a list of domain IDs, not domain names. The user must be authenticated to call this method.

Parameters:

_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

starred_domain_remove(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → None#

Removes from starred domains

Removes the domain from the list of starred domains for the user.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

starred_domain_remove_with_http_info(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.api_response.ApiResponse[None]#

Removes from starred domains

Removes the domain from the list of starred domains for the user.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

starred_domain_remove_without_preload_content(domain_id: Annotated[str, Field(strict=True)], _request_timeout: Union[None, Annotated[pydantic.StrictFloat, Field(gt=0)], Tuple[Annotated[pydantic.StrictFloat, Field(gt=0)], Annotated[pydantic.StrictFloat, Field(gt=0)]]] = None, _request_auth: Dict[pydantic.StrictStr, Any] | None = None, _content_type: pydantic.StrictStr | None = None, _headers: Dict[pydantic.StrictStr, Any] | None = None, _host_index: Annotated[pydantic.StrictInt, Field(ge=0, le=0)] = 0) → antimatter.client.rest.RESTResponseType#

Removes from starred domains

Removes the domain from the list of starred domains for the user.

Parameters:

domain_id (str) – (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

antimatter.client.api.default_api#

Module Contents#

Classes#

`antimatter.client.api.default_api`#