8 releases (4 stable)
| new 1.0.5 | May 17, 2024 |
|---|---|
| 1.0.2 | May 13, 2024 |
| 1.0.1 | Apr 25, 2024 |
| 0.1.13 | Apr 3, 2024 |
| 0.1.11 | Mar 29, 2024 |
#32 in #cloud
1,163 downloads per month
Used in antimatter
445KB
7K
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: 1.0.5
- Package version: 1.0.5
- 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 |
|---|---|---|---|
| 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_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_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_add_read_context_rule | POST /domains/{domainID}/control/read-context/{contextName}/config | Add a read context configuration rule |
| ContextsApi | domain_delete_read_context | DELETE /domains/{domainID}/control/read-context/{contextName} | Delete a read context |
| ContextsApi | domain_delete_read_context_rule | DELETE /domains/{domainID}/control/read-context/{contextName}/config/{ruleID} | Delete a read context configuration rule |
| ContextsApi | domain_delete_write_context | DELETE /domains/{domainID}/control/write-context/{contextName} | Delete a write context |
| 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_regex_rules | GET /domains/{domainID}/control/write-context/{contextName}/regex-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_read_context_flush | POST /domains/{domainID}/control/read-context/{contextName}/flush | Flush the read context cache |
| ContextsApi | domain_update_read_context_rule | PUT /domains/{domainID}/control/read-context/{contextName}/config/{ruleID} | Update a read context configuration rule |
| 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/keys | Add a new external root encryption key. |
| EncryptionApi | domain_delete_external_root_encryption_key | DELETE /domains/{domainID}/control/keys/{rootEncryptionKeyID} | Delete an external root encryption key by ID. |
| EncryptionApi | domain_external_root_encryption_key_test | POST /domains/{domainID}/control/keys/{rootEncryptionKeyID}/test | Test the health of a root encryption key |
| EncryptionApi | domain_flush_encryption_keys | POST /domains/{domainID}/encryption/flush | Flush all encryption keys |
| EncryptionApi | domain_get_active_external_root_encryption_key | GET /domains/{domainID}/control/keys/active | Get the active root encryption key's information. |
| EncryptionApi | domain_get_external_root_encryption_key_providers | GET /domains/{domainID}/control/keys/providers | Returns a list of available root encryption key providers. |
| EncryptionApi | domain_list_external_root_encryption_key | GET /domains/{domainID}/control/keys | List all external root encryption keys. |
| EncryptionApi | domain_rotate_root_encryption_keys | POST /domains/{domainID}/control/keys/rotate | Re-encrypt key encryption keys. |
| EncryptionApi | domain_set_active_external_root_encryption_key | POST /domains/{domainID}/control/keys/active | Set the active root encryption key |
| GeneralApi | domain_add_new | POST /domains | Add a new domain |
| GeneralApi | domain_create_peer_domain | POST /domains/{domainID}/peer-domain | Create a peer domain |
| GeneralApi | domain_delete_peer | DELETE /domains/{domainID}/control/peers/{peerDomainID} | Delete a peer domain |
| 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_list_peers | GET /domains/{domainID}/control/peers | List domain peers |
| GeneralApi | domain_patch_settings | PATCH /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_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 |
| PolicyApi | domain_create_policy_rule | POST /domains/{domainID}/control/policy | Create a domain policy rule |
| PolicyApi | domain_delete_fact_by_id | DELETE /domains/{domainID}/control/facts/{factType}/{factID} | 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_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_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_policy_rules | POST /domains/{domainID}/control/policy/renumber | Re-assign rule numbers |
| 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
- AccessLogEntry
- AccessLogEntryCreateInfo
- AccessLogEntryOpenInfo
- AccessLogEntryReadInfo
- AccessLogResults
- ActiveRootEncryptionKeyId
- AddCapsuleLogEntryRequest
- AddReadContext
- AddWriteContext
- AntimatterDelegatedAwsKeyInfo
- ApiKeyDomainIdentityProviderDetails
- AvailableDelegatedRootEncryptionKeyProvider
- AvailableRootEncryptionKeyProviders
- AvailableRootEncryptionKeyProvidersProvidersInner
- AvailableServiceAccountRootEncryptionKeyProvider
- AwsServiceAccountKeyInfo
- Capability
- CapabilityDefinition
- CapabilityDefinitionList
- CapabilityList
- CapabilityRule
- CapabilityRuleMatchExpressionsInner
- CapsuleCreateResponse
- CapsuleInfo
- CapsuleList
- CapsuleOpenRequest
- CapsuleOpenResponse
- CapsuleOpenResponseReadContextConfiguration
- CapsuleSealRequest
- ConflictError
- CreatePeerDomain
- DataTaggingHookInput
- DataTaggingHookInputRecordsInner
- DataTaggingHookInputRecordsInnerElementsInner
- DataTaggingHookResponse
- DataTaggingHookResponseRecordsInner
- DeleteTags
- Domain
- DomainAddReadContextRule200Response
- DomainAuthenticate
- DomainAuthenticateResponse
- DomainContactIssueVerifyRequest
- DomainControlLogEntry
- DomainControlLogResults
- DomainFactList
- DomainHooksList
- DomainHooksListHooksInner
- DomainIdentityApiKeyPrincipalParams
- DomainIdentityEmailPrincipalParams
- DomainIdentityHostedDomainPrincipalParams
- DomainIdentityPrincipalDetails
- DomainIdentityProviderDetails
- DomainIdentityProviderInfo
- DomainIdentityProviderList
- DomainIdentityProviderPrincipalList
- DomainIdentityProviderPrincipalParams
- DomainIdentityProviderPrincipalType
- DomainIdentityProviderType
- DomainInsertIdentityProviderPrincipal200Response
- DomainInsertWriteContextRegexRule200Response
- DomainPeerConfig
- DomainPeerList
- DomainPeerListPeersInner
- DomainPolicy
- DomainPolicyRule
- DomainPrivateInfo
- DomainPublicInfo
- DomainResourceSummary
- DomainResourceSummarySchemaInner
- DomainSettings
- DomainSettingsDisasterRecovery
- DomainSettingsPatch
- DomainStatus
- DomainStatusNotificationsInner
- DomainTagInfoResults
- Error
- Fact
- FactList
- FactPolicyRulesInner
- FactPolicyRulesInnerArgumentsInner
- FactTypeDefinition
- ForbiddenError
- GcpServiceAccountKeyInfo
- GoogleOAuthDomainIdentityProviderDetails
- HookInvocation
- InvalidRequestError
- JsonPatchRequestAdd
- JsonPatchRequestAddValue
- JsonPatchRequestCopy
- JsonPatchRequestMove
- JsonPatchRequestRemove
- JsonPatchRequestReplace
- JsonPatchRequestReplaceValue
- JsonPatchRequestTst
- JsonPatchRequestTstValue
- KeyInfos
- KeyInfosKeyInformation
- NewAccessLogEntry
- NewAccessLogEntryReadInfo
- NewCapabilityDefinition
- NewDomain
- NewDomainPolicyRule
- NewDomainResponse
- NewFact
- NewFactTypeDefinition
- NewFactTypeDefinitionArgumentsInner
- NewReadContextConfigRule
- PatchRequestInner
- PolicyRuleOperation
- PolicyRuleResult
- PrincipalInfo
- PrincipalSummary
- ReadContextConfigRule
- ReadContextDetails
- ReadContextList
- ReadContextParameter
- ReadContextRequiredHook
- ReadContextRuleFactsInner
- ReadContextRuleFactsInnerArgumentsInner
- ReadContextRuleMatchExpressionsInner
- ReadContextShortDetails
- ResourceExhaustedError
- ResourceNotFoundError
- RootEncryptionKeyIdResponse
- RootEncryptionKeyItem
- RootEncryptionKeyTestResponse
- RotateKeyEncryptionKeyResponse
- StarredDomainList
- Tag
- TagMeta
- TagSet
- TagSetSpanTagsInner
- TagSummary
- TagSummaryElidedTagsInner
- TagSummaryUniqueTagsInner
- TagTypeField
- UnauthorizedError
- UpsertSpanTagsRequest
- VerifyContactResponse
- WriteContextConfigInfo
- WriteContextConfigInfoRequiredHooksInner
- WriteContextDetails
- WriteContextList
- WriteContextRegexRule
- WriteContextRegexTag
To get access to the crate's generated documentation, use:
cargo doc --open
Author
Dependencies
~4–19MB
~265K SLoC