antimatter_api

Crates.ioantimatter_api
lib.rsantimatter_api
version1.0.2
sourcesrc
created_at2024-03-28 05:04:01.431197
updated_at2024-05-13 15:09:45.739189
descriptionInteract with the Antimatter Cloud API
homepage
repository
max_upload_size
id1188754
size437,990
Michael Andersen (immesys)

documentation

README

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: 1.1.6
  • Package version: 1.1.6
  • Generator version: 7.4.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/v1

Class Method HTTP request Description

DefaultApi | capsule_get_by_id | GET /capsules/{capsuleID} | Get a Capsule by ID DefaultApi | domain_add_access_log_entry | POST /domains/{domainID}/capsules/{capsuleID}/log | Add a capsule audit log entry DefaultApi | domain_add_external_root_encryption_key | POST /domains/{domainID}/control/keys | Add a new external root encryption key. DefaultApi | domain_add_new | POST /domains | Add a new domain DefaultApi | domain_add_read_context_rule | POST /domains/{domainID}/control/read-context/{contextName}/config | Add a read context configuration rule DefaultApi | domain_authenticate | POST /domains/{domainID}/authenticate | Authenticate with a domain DefaultApi | domain_contact_issue_verify | POST /domains/{domainID}/account/verify | Issue a new verification request DefaultApi | domain_contact_verify | GET /domains/{domainID}/account/verify | Verify an admin account recently associated with a domain DefaultApi | domain_create_capsule | POST /domains/{domainID}/capsules | Create a capsule DefaultApi | domain_create_peer_domain | POST /domains/{domainID}/peer-domain | Create a peer domain DefaultApi | domain_create_policy_rule | POST /domains/{domainID}/control/policy | Create a domain policy rule DefaultApi | domain_data_tagging_hook_invoke | POST /domains/{domainID}/hooks/data-tagging/{hookName}/invoke | Invoke a hook DefaultApi | domain_delete_capability | DELETE /domains/{domainID}/control/capabilities/{capability} | Delete a capability DefaultApi | domain_delete_capsule_tags | POST /domains/{domainID}/capsules/{capsuleID}/capsule-tags/delete | Delete capsule-level tags DefaultApi | domain_delete_external_root_encryption_key | DELETE /domains/{domainID}/control/keys/{rootEncryptionKeyID} | Delete an external root encryption key by ID. DefaultApi | domain_delete_fact_by_id | DELETE /domains/{domainID}/control/facts/{factType}/{factID} | Delete a fact DefaultApi | domain_delete_fact_type | DELETE /domains/{domainID}/control/facts/{factType} | Delete a fact type DefaultApi | domain_delete_identity_provider | DELETE /domains/{domainID}/control/identities/{identityProviderName} | Delete an identity provider DefaultApi | domain_delete_identity_provider_principal | DELETE /domains/{domainID}/control/identities/{identityProviderName}/principals/{principalID} | Delete identity provider principal DefaultApi | domain_delete_peer | DELETE /domains/{domainID}/control/peers/{peerDomainID} | Delete a peer domain DefaultApi | domain_delete_policy_rule | DELETE /domains/{domainID}/control/policy/{ruleID} | Delete a domain policy rule DefaultApi | domain_delete_read_context | DELETE /domains/{domainID}/control/read-context/{contextName} | Delete a read context DefaultApi | domain_delete_read_context_rule | DELETE /domains/{domainID}/control/read-context/{contextName}/config/{ruleID} | Delete a read context configuration rule DefaultApi | domain_delete_write_context | DELETE /domains/{domainID}/control/write-context/{contextName} | Delete a write context DefaultApi | domain_delete_write_context_regex_rule | DELETE /domains/{domainID}/control/write-context/{contextName}/regex-rule/{ruleID} | DefaultApi | domain_describe_write_context | GET /domains/{domainID}/control/write-context/{contextName} | Describe a write context DefaultApi | domain_external_root_encryption_key_test | POST /domains/{domainID}/control/keys/{rootEncryptionKeyID}/test | Test the health of a root encryption key DefaultApi | domain_flush_encryption_keys | POST /domains/{domainID}/encryption/flush | Flush all encryption keys DefaultApi | domain_get_active_external_root_encryption_key | GET /domains/{domainID}/control/keys/active | Get the active root encryption key's information. DefaultApi | domain_get_capabilities | GET /domains/{domainID}/control/capabilities | Get the domain capabilities DefaultApi | domain_get_capability | GET /domains/{domainID}/control/capabilities/{capability} | Get a single capability DefaultApi | domain_get_capsule_info | GET /domains/{domainID}/capsules/{capsuleID} | Get capsule info DefaultApi | domain_get_external_root_encryption_key_providers | GET /domains/{domainID}/control/keys/providers | Returns a list of available root encryption key providers. DefaultApi | domain_get_fact_by_id | GET /domains/{domainID}/control/facts/{factType}/{factID} | Get a fact by ID DefaultApi | domain_get_fact_type | GET /domains/{domainID}/control/facts/{factType} | Get a fact type definition DefaultApi | domain_get_identity_provider | GET /domains/{domainID}/control/identities/{identityProviderName} | Get an identity provider's details DefaultApi | domain_get_identity_provider_principal | GET /domains/{domainID}/control/identities/{identityProviderName}/principals/{principalID} | Get identity provider principal details DefaultApi | domain_get_identity_provider_principals | GET /domains/{domainID}/control/identities/{identityProviderName}/principals | Get an identity provider's principals DefaultApi | domain_get_peer | GET /domains/{domainID}/peer-domain | Get a peer domain by nickname or alias DefaultApi | domain_get_peer_config | GET /domains/{domainID}/control/peers/{peerDomainID} | Get peer configuration DefaultApi | domain_get_private_info | GET /domains/{domainID}/info | Get the summary info for a Domain DefaultApi | domain_get_public_info | GET /domains/{domainID}/public-info | Get the public info for a Domain DefaultApi | domain_get_read_context | GET /domains/{domainID}/control/read-context/{contextName} | Get a read context DefaultApi | domain_get_settings | GET /domains/{domainID}/control/settings | Get the domain settings DefaultApi | domain_get_status | GET /domains/{domainID}/control/status | Get the domain status DefaultApi | domain_get_tag_info | GET /domains/{domainID}/tag-info | Get an ordered list of the top 100 tags. DefaultApi | domain_get_write_context_regex_rules | GET /domains/{domainID}/control/write-context/{contextName}/regex-rule | DefaultApi | domain_insert_identity_provider_principal | POST /domains/{domainID}/control/identities/{identityProviderName}/principals | Create a new principal for the provider DefaultApi | domain_insert_write_context_regex_rule | POST /domains/{domainID}/control/write-context/{contextName}/regex-rule | Insert a write context regex rule DefaultApi | domain_list_capsules | GET /domains/{domainID}/capsules | Get capsule list DefaultApi | domain_list_external_root_encryption_key | GET /domains/{domainID}/control/keys | List all external root encryption keys. DefaultApi | domain_list_fact_types | GET /domains/{domainID}/control/facts | List the domain's fact types DefaultApi | domain_list_facts | GET /domains/{domainID}/control/facts/{factType}/list | Get facts for a type DefaultApi | domain_list_hooks | GET /domains/{domainID}/hooks | Lists available hooks DefaultApi | domain_list_identity_providers | GET /domains/{domainID}/control/identities | Get a summary of the domain's Identity Providers DefaultApi | domain_list_peers | GET /domains/{domainID}/control/peers | List domain peers DefaultApi | domain_list_policy_rules | GET /domains/{domainID}/control/policy | Get the domain policy rules DefaultApi | domain_list_read_contexts | GET /domains/{domainID}/control/read-context | List domain read contexts DefaultApi | domain_list_resources | GET /domains/{domainID}/control/resources | Get a summary of access control resource paths DefaultApi | domain_list_write_contexts | GET /domains/{domainID}/control/write-context | List domain write contexts DefaultApi | domain_open_capsule | POST /domains/{domainID}/capsules/{capsuleID}/open | Open a capsule for reading DefaultApi | domain_patch_settings | PATCH /domains/{domainID}/control/settings | Update the domain settings DefaultApi | domain_policy_flush | POST /domains/{domainID}/control/policy/flush | Flush the policy cache DefaultApi | domain_put_capability | PUT /domains/{domainID}/control/capabilities/{capability} | Create or update a capability DefaultApi | domain_put_fact_type | PUT /domains/{domainID}/control/facts/{factType} | Create a fact type DefaultApi | domain_query_access_log | GET /domains/{domainID}/log | Get the domain data-plane audit log DefaultApi | domain_query_access_log_single_capsule | GET /domains/{domainID}/capsules/{capsuleID}/log | Get the access log for a single capsule DefaultApi | domain_query_control_log | GET /domains/{domainID}/control/log | Get the domain control-plane audit log DefaultApi | domain_renumber_policy_rules | POST /domains/{domainID}/control/policy/renumber | Re-assign rule numbers DefaultApi | domain_rotate_root_encryption_keys | POST /domains/{domainID}/control/keys/rotate | Re-encrypt key encryption keys with active root encryption key. DefaultApi | domain_seal_capsule | POST /domains/{domainID}/capsules/{capsuleID}/seal | Seal a capsule DefaultApi | domain_set_active_external_root_encryption_key | POST /domains/{domainID}/control/keys/active | Set the root encryption key ID that should be used. DefaultApi | domain_update_identity_provider_principal | PUT /domains/{domainID}/control/identities/{identityProviderName}/principals/{principalID} | Update identity provider principal capabilities DefaultApi | domain_update_peer | PUT /domains/{domainID}/control/peers/{peerDomainID} | Update peer configuration DefaultApi | domain_update_policy_rule | PUT /domains/{domainID}/control/policy/{ruleID} | Update a domain policy rule DefaultApi | domain_update_read_context_rule | PUT /domains/{domainID}/control/read-context/{contextName}/config/{ruleID} | Update a read context configuration rule DefaultApi | domain_upsert_capsule_tags | POST /domains/{domainID}/capsules/{capsuleID}/capsule-tags | Upsert capsule-scope tags DefaultApi | domain_upsert_fact | POST /domains/{domainID}/control/facts/{factType}/new | Upsert a fact DefaultApi | domain_upsert_identity_provider | PUT /domains/{domainID}/control/identities/{identityProviderName} | Create/Update an identity provider DefaultApi | domain_upsert_read_context | PUT /domains/{domainID}/control/read-context/{contextName} | Update or create a read context DefaultApi | domain_upsert_span_tags | PUT /domains/{domainID}/capsules/{capsuleID}/span-tags | Upsert span-scope tags DefaultApi | domain_upsert_write_context | PUT /domains/{domainID}/control/write-context/{contextName} | Upsert a write context DefaultApi | domain_upsert_write_context_configuration | PUT /domains/{domainID}/control/write-context/{contextName}/config | Update a write context configuration DefaultApi | starred_domain_add | PUT /global/starred-domains/{domainID} | Adds to starred domains DefaultApi | starred_domain_list | GET /global/starred-domains | List the user's starred domains DefaultApi | starred_domain_remove | DELETE /global/starred-domains/{domainID} | Removes from starred domains

Documentation For Models

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

cargo doc --open

Author

support@antimatter.io

Commit count: 0

cargo fmt