Lib.rs

› Web programming › Antimatter
#api-client #cloud #antimatter

antimatter_api

Interact with the Antimatter Cloud API

Owned by Michael Andersen.

26 stable releases

2.0.13 Nov 21, 2024
2.0.8 Aug 29, 2024
2.0.6 Jul 25, 2024
1.1.7 Jul 24, 2024
0.1.11 Mar 29, 2024

#433 in Web programming

Download history 306/week @ 2024-08-18 730/week @ 2024-08-25 334/week @ 2024-09-01 669/week @ 2024-09-08 156/week @ 2024-09-15 264/week @ 2024-09-22 54/week @ 2024-09-29 94/week @ 2024-10-06 111/week @ 2024-10-13 20/week @ 2024-10-20 17/week @ 2024-10-27 67/week @ 2024-11-03 21/week @ 2024-11-10 654/week @ 2024-11-17 114/week @ 2024-11-24 38/week @ 2024-12-01

828 downloads per month
Used in antimatter

Apache-2.0

610KB
10K SLoC

Rust API client for antimatter_api

Interact with the Antimatter Cloud API

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 2.0.13
  • Package version: 2.0.13
  • Generator version: 7.10.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named antimatter_api and add the following to Cargo.toml under [dependencies]:

antimatter_api = { path = "./antimatter_api" }

Documentation for API Endpoints

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

Class Method HTTP request Description
AccountManagementApi starred_domain_add PUT /global/starred-domains/{domainID} Adds to starred domains
AccountManagementApi starred_domain_list GET /global/starred-domains List the user's starred domains
AccountManagementApi starred_domain_remove DELETE /global/starred-domains/{domainID} Removes from starred domains
AuthenticationApi domain_authenticate POST /domains/{domainID}/authenticate Authenticate with a domain
AuthenticationApi domain_contact_issue_verify POST /domains/{domainID}/account/verify Issue a new verification request
AuthenticationApi domain_contact_verify GET /domains/{domainID}/account/verify Verify an admin contact email
AuthenticationApi domain_delete_capability DELETE /domains/{domainID}/control/capabilities/{capability} Delete a capability
AuthenticationApi domain_delete_identity_provider DELETE /domains/{domainID}/control/identities/{identityProviderName} Delete an identity provider
AuthenticationApi domain_delete_identity_provider_principal DELETE /domains/{domainID}/control/identities/{identityProviderName}/principals/{principalID} Delete identity provider principal
AuthenticationApi domain_get_capabilities GET /domains/{domainID}/control/capabilities Get the domain capabilities
AuthenticationApi domain_get_capability GET /domains/{domainID}/control/capabilities/{capability} Get a single capability
AuthenticationApi domain_get_identity_group_providers GET /domains/{domainID}/control/identities/group-providers Get supported group identity provider details
AuthenticationApi domain_get_identity_provider GET /domains/{domainID}/control/identities/{identityProviderName} Get an identity provider's details
AuthenticationApi domain_get_identity_provider_principal GET /domains/{domainID}/control/identities/{identityProviderName}/principals/{principalID} Get identity provider principal details
AuthenticationApi domain_get_identity_provider_principals GET /domains/{domainID}/control/identities/{identityProviderName}/principals Get an identity provider's principals
AuthenticationApi domain_insert_identity_provider_principal POST /domains/{domainID}/control/identities/{identityProviderName}/principals Create a new principal for the provider
AuthenticationApi domain_list_identity_providers GET /domains/{domainID}/control/identities Get a summary of the domain's Identity Providers
AuthenticationApi domain_put_capability PUT /domains/{domainID}/control/capabilities/{capability} Create or update a capability
AuthenticationApi domain_put_vendor_settings PUT /domains/{domainID}/control/vendor/settings Create or update vendor settings
AuthenticationApi domain_update_identity_provider_principal PUT /domains/{domainID}/control/identities/{identityProviderName}/principals/{principalID} Update identity provider principal capabilities
AuthenticationApi domain_upsert_identity_provider PUT /domains/{domainID}/control/identities/{identityProviderName} Create/Update an identity provider
CapsulesApi capsule_get_by_id GET /capsules/{capsuleID} Get a Capsule by ID
CapsulesApi domain_delete_capsule_tags POST /domains/{domainID}/capsules/{capsuleID}/capsule-tags/delete Delete capsule-level tags
CapsulesApi domain_get_capsule_info GET /domains/{domainID}/capsules/{capsuleID} Get capsule info
CapsulesApi domain_get_tag_info GET /domains/{domainID}/tag-info Get an ordered list of the top 100 tags.
CapsulesApi domain_list_capsules GET /domains/{domainID}/capsules Get capsule list
CapsulesApi domain_query_access_log GET /domains/{domainID}/log Get the domain data-plane audit log
CapsulesApi domain_query_access_log_single_capsule GET /domains/{domainID}/capsules/{capsuleID}/log Get the access log for a single capsule
CapsulesApi domain_upsert_capsule_tags POST /domains/{domainID}/capsules/{capsuleID}/capsule-tags Upsert capsule-scope tags
ContextsApi domain_delete_read_context DELETE /domains/{domainID}/control/read-context/{contextName} Delete a read context
ContextsApi domain_delete_write_context DELETE /domains/{domainID}/control/write-context/{contextName} Delete a write context
ContextsApi domain_delete_write_context_classifier_rule DELETE /domains/{domainID}/control/write-context/{contextName}/classifier-rule/{ruleID}
ContextsApi domain_delete_write_context_regex_rule DELETE /domains/{domainID}/control/write-context/{contextName}/regex-rule/{ruleID}
ContextsApi domain_describe_write_context GET /domains/{domainID}/control/write-context/{contextName} Describe a write context
ContextsApi domain_get_read_context GET /domains/{domainID}/control/read-context/{contextName} Get a read context
ContextsApi domain_get_write_context_classifier_rules GET /domains/{domainID}/control/write-context/{contextName}/classifier-rule
ContextsApi domain_get_write_context_regex_rules GET /domains/{domainID}/control/write-context/{contextName}/regex-rule
ContextsApi domain_insert_write_context_classifier_rule POST /domains/{domainID}/control/write-context/{contextName}/classifier-rule Insert a write context classifier rule
ContextsApi domain_insert_write_context_regex_rule POST /domains/{domainID}/control/write-context/{contextName}/regex-rule Insert a write context regex rule
ContextsApi domain_list_hooks GET /domains/{domainID}/hooks Lists available hooks
ContextsApi domain_list_read_contexts GET /domains/{domainID}/control/read-context List domain read contexts
ContextsApi domain_list_write_contexts GET /domains/{domainID}/control/write-context List domain write contexts
ContextsApi domain_upsert_read_context PUT /domains/{domainID}/control/read-context/{contextName} Update or create a read context
ContextsApi domain_upsert_write_context PUT /domains/{domainID}/control/write-context/{contextName} Upsert a write context
ContextsApi domain_upsert_write_context_configuration PUT /domains/{domainID}/control/write-context/{contextName}/config Update a write context configuration
EncryptionApi domain_add_external_root_encryption_key POST /domains/{domainID}/control/encryption/keys Add a new external root encryption key.
EncryptionApi domain_delete_external_root_encryption_key DELETE /domains/{domainID}/control/encryption/keys/{rootEncryptionKeyID} Delete an external root encryption key by ID.
EncryptionApi domain_external_root_encryption_key_test POST /domains/{domainID}/control/encryption/keys/{rootEncryptionKeyID}/test Test the health of a root encryption key
EncryptionApi domain_flush_encryption_keys POST /domains/{domainID}/control/encryption/flush Flush all encryption keys
EncryptionApi domain_get_active_external_root_encryption_key GET /domains/{domainID}/control/encryption/active-key Get the active root encryption key's information.
EncryptionApi domain_get_encryption_settings GET /domains/{domainID}/control/encryption/settings Get encryption-related settings for a domain.
EncryptionApi domain_get_external_root_encryption_key GET /domains/{domainID}/control/encryption/keys/{rootEncryptionKeyID} Get an external root encryption key by ID.
EncryptionApi domain_get_external_root_encryption_key_providers GET /domains/{domainID}/control/encryption/providers Returns a list of available root encryption key providers.
EncryptionApi domain_list_external_root_encryption_key GET /domains/{domainID}/control/encryption/keys List all external root encryption keys.
EncryptionApi domain_put_encryption_settings PUT /domains/{domainID}/control/encryption/settings Update encryption settings for a domain.
EncryptionApi domain_rotate_root_encryption_keys POST /domains/{domainID}/control/encryption/rotate Re-encrypt key encryption keys.
EncryptionApi domain_set_active_external_root_encryption_key POST /domains/{domainID}/control/encryption/active-key Set the active root encryption key
GeneralApi domain_add_new POST /domains Add a new domain
GeneralApi domain_add_peer_domain POST /domains/{domainID}/peer-domain Add a peer domain
GeneralApi domain_delete_peer DELETE /domains/{domainID}/control/peers/{peerDomainID} Delete a peer domain
GeneralApi domain_get_disaster_recovery_settings GET /domains/{domainID}/control/keys/disaster-recovery Get a domain's disaster recovery settings.
GeneralApi domain_get_peer GET /domains/{domainID}/peer-domain Get a peer domain by nickname or alias
GeneralApi domain_get_peer_config GET /domains/{domainID}/control/peers/{peerDomainID} Get peer configuration
GeneralApi domain_get_private_info GET /domains/{domainID}/info Get the summary info for a Domain
GeneralApi domain_get_public_info GET /domains/{domainID}/public-info Get the public info for a Domain
GeneralApi domain_get_settings GET /domains/{domainID}/control/settings Get the domain settings
GeneralApi domain_get_status GET /domains/{domainID}/control/status Get the domain status
GeneralApi domain_get_vendor_settings GET /domains/{domainID}/control/vendor/settings Get vendor settings for the domain
GeneralApi domain_list_peers GET /domains/{domainID}/control/peers List domain peers
GeneralApi domain_put_disaster_recovery_settings PUT /domains/{domainID}/control/keys/disaster-recovery Create or update a domain's disaster recovery settings.
GeneralApi domain_put_settings PUT /domains/{domainID}/control/settings Update the domain settings
GeneralApi domain_query_control_log GET /domains/{domainID}/control/log Get the domain control-plane audit log
GeneralApi domain_update_peer PUT /domains/{domainID}/control/peers/{peerDomainID} Update peer configuration
InternalApi domain_add_access_log_entry POST /domains/{domainID}/capsules/{capsuleID}/log Add a capsule audit log entry
InternalApi domain_create_capsule POST /domains/{domainID}/capsules Create a capsule
InternalApi domain_data_tagging_hook_invoke POST /domains/{domainID}/hooks/data-tagging/{hookName}/invoke Invoke a hook
InternalApi domain_data_tagging_hook_test POST /domains/{domainID}/hooks/data-tagging/{hookName}/test Test a classifier rule with real input
InternalApi domain_open_capsule POST /domains/{domainID}/capsules/{capsuleID}/open Open a capsule for reading
InternalApi domain_seal_capsule POST /domains/{domainID}/capsules/{capsuleID}/seal Seal a capsule
InternalApi domain_upsert_span_tags PUT /domains/{domainID}/capsules/{capsuleID}/span-tags Upsert span-scope tags
KeychainApi keychain_create_workspace POST /keychain/workspaces Create a workspace
KeychainApi keychain_get_workspace_info GET /keychain/workspaces/{workspace}/info Get information about a workspace
KeychainApi keychain_get_workspace_objects GET /keychain/workspaces/{workspace}/objects Get a batch of objects in a workspace
KeychainApi keychain_put_workspace_objects POST /keychain/workspaces/{workspace}/objects Put a batch of objects in a workspace
PolicyApi domain_create_data_policy POST /domains/{domainID}/control/data-policy Create a new data policy
PolicyApi domain_create_policy_rule POST /domains/{domainID}/control/policy Create a domain policy rule
PolicyApi domain_data_policy_configure_rules POST /domains/{domainID}/control/data-policy/{policyID}/rules Configure data policy rules
PolicyApi domain_data_policy_rule_update PUT /domains/{domainID}/control/data-policy/{policyID}/rules/{ruleID} Configure data policy rule
PolicyApi domain_delete_data_policy DELETE /domains/{domainID}/control/data-policy/{policyID} Delete a data policy
PolicyApi domain_delete_data_policy_rule DELETE /domains/{domainID}/control/data-policy/{policyID}/rules/{ruleID} Delete a data policy policy
PolicyApi domain_delete_fact_by_id DELETE /domains/{domainID}/control/facts/{factType}/{factID} Delete a fact
PolicyApi domain_delete_fact_by_tuple DELETE /domains/{domainID}/control/facts/{factType}/tuple Delete a fact
PolicyApi domain_delete_fact_type DELETE /domains/{domainID}/control/facts/{factType} Delete a fact type
PolicyApi domain_delete_policy_rule DELETE /domains/{domainID}/control/policy/{ruleID} Delete a domain policy rule
PolicyApi domain_get_data_policy GET /domains/{domainID}/control/data-policy/{policyID} Get a data policy
PolicyApi domain_get_data_policy_binding GET /domains/{domainID}/control/data-policy/{policyID}/binding Retrieve a data policy binding
PolicyApi domain_get_data_policy_rule GET /domains/{domainID}/control/data-policy/{policyID}/rules/{ruleID} Get a data policy rule
PolicyApi domain_get_fact_by_id GET /domains/{domainID}/control/facts/{factType}/{factID} Get a fact by ID
PolicyApi domain_get_fact_type GET /domains/{domainID}/control/facts/{factType} Get a fact type definition
PolicyApi domain_list_data_policies GET /domains/{domainID}/control/data-policy
PolicyApi domain_list_fact_types GET /domains/{domainID}/control/facts List the domain's fact types
PolicyApi domain_list_facts GET /domains/{domainID}/control/facts/{factType}/list Get facts for a type
PolicyApi domain_list_policy_rules GET /domains/{domainID}/control/policy Get the domain policy rules
PolicyApi domain_list_resources GET /domains/{domainID}/control/resources Get a summary of access control resource paths
PolicyApi domain_policy_flush POST /domains/{domainID}/control/policy/flush Flush the policy cache
PolicyApi domain_put_fact_type PUT /domains/{domainID}/control/facts/{factType} Create a fact type
PolicyApi domain_renumber_data_policy_rules POST /domains/{domainID}/control/data-policy/{policyID}/renumber Re-assign rule numbers
PolicyApi domain_renumber_policy_rules POST /domains/{domainID}/control/policy/renumber Re-assign rule numbers
PolicyApi domain_set_data_policy_binding PUT /domains/{domainID}/control/data-policy/{policyID}/binding Configure data policy binding
PolicyApi domain_update_data_policy PUT /domains/{domainID}/control/data-policy/{policyID} Update a data policy
PolicyApi domain_update_policy_rule PUT /domains/{domainID}/control/policy/{ruleID} Update a domain policy rule
PolicyApi domain_upsert_fact POST /domains/{domainID}/control/facts/{factType}/new Upsert a fact

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

support@antimatter.io

Dependencies

~8–20MB
~276K SLoC