Skip to main content

Module models

Module models 

Source
Expand description

API request and response models for the ANS Registry.

These types map to the OpenAPI specification for the ANS API.

Structs§

AgentDetails
Detailed agent information.
AgentEndpoint
An agent endpoint configuration.
AgentFunction
A function/capability provided by an agent endpoint.
AgentRegistrationRequest
Request to register a new agent.
AgentResolutionRequest
Resolution request.
AgentResolutionResponse
Resolution response.
AgentRevocationRequest
Request to revoke an agent.
AgentRevocationResponse
Revocation response.
AgentSearchResponse
Search results response.
AgentSearchResult
Agent search result.
AgentStatus
Agent status information.
CertificateResponse
Certificate information.
ChallengeInfo
ACME challenge information.
CsrStatusResponse
CSR status response.
CsrSubmissionRequest
CSR submission request.
CsrSubmissionResponse
CSR submission response.
DnsRecord
DNS record to be configured.
DnsRecordDetails
DNS record details for ACME challenge.
EventItem
An individual agent event.
EventPageResponse
Paginated events response.
Link
HATEOAS link.
NextStep
A required action to continue registration.
RegistrationPending
Response for pending registration.
SearchCriteria
Search criteria.

Enums§

AgentLifecycleStatus
Agent lifecycle status.
ChallengeType
ACME challenge type.
CsrStatus
CSR status.
CsrType
CSR type.
EventType
Event type for agent lifecycle events.
NextStepAction
Action to take in next step.
Protocol
Communication protocol used by agents.
RegistrationPhase
Registration phase.
RegistrationStatus
Registration status.
RevocationReason
Revocation reason (RFC 5280).
Transport
Transport mechanism for agent communication.