# components.headers.AcceptPatch.description
Advertises the patch media type accepted for this resource.

# components.headers.ETag.description
Strong entity tag for revision-aware representations and mutation results.

# components.headers.Link.description
RFC 8288 relation header for canonical or pagination links.

# components.headers.Location.description
Canonical location of the created or accepted resource.

# components.parameters.CSRFTokenHeader.description
CSRF token required for unsafe HTTP methods.

# components.parameters.CommonDomainsQuery.description
Include common domains when rendering Apple provisioning output.

# components.parameters.FilterAggregationLevelEQQuery.description
Exact DNS rollup aggregation level filter.

# components.parameters.FilterObservedAtGTEQuery.description
Inclusive lower RFC3339 timestamp bound for raw DNS log observations.

# components.parameters.FilterObservedAtLTQuery.description
Exclusive upper RFC3339 timestamp bound for raw DNS log observations.

# components.parameters.FilterPOPLogWindowIDEQQuery.description
Exact POP-local raw DNS log window identifier filter.

# components.parameters.IdempotencyKeyHeaderOptional.description
Optional idempotency key for replay-safe mutation routes.

# components.parameters.IdempotencyKeyHeaderRequired.description
Required idempotency key for replay-safe mutation routes.

# components.parameters.IfMatchHeaderRequired.description
Strong ETag precondition for revisioned mutations.

# components.parameters.POPLogWindowIDQuery.description
POP-local raw DNS log window identifier.

# components.parameters.PageSizeQuery.description
Requested page size for cursor pagination.

# components.parameters.RawLogObservedAfterQuery.description
Inclusive lower RFC3339 timestamp bound for raw DNS log observations.

# components.parameters.RawLogObservedBeforeQuery.description
Exclusive upper RFC3339 timestamp bound for raw DNS log observations.

# components.parameters.SearchQuery.description
Free-text search term for searchable collections.

# components.parameters.SignedQuery.description
Return signed provisioning profile material when supported.

# components.parameters.SortQuery.description
Stable sort key list for cursor pagination.

# components.securitySchemes.cookieAuth.description
HttpOnly access token cookie used for authenticated requests.

# info.description
Use this reference to integrate with Veilty account, tenant, DNS policy, endpoint, and observability workflows.

Public preview: this API is subject to change until Veilty's public launch. Some operations may not be publicly available to every caller, and request shapes, response shapes, and paths may change before launch.

Self-service shortcuts under /v1/me are available only when the session resolves to exactly one effective tenant, the tenant allows self-service, and the feature is enabled. Use account-scoped or tenant-scoped routes when you need explicit scope, have multiple tenant contexts, or self-service shortcuts are disabled.

# paths./healthz.get.description
Returns coarse public liveness status for load balancer and edge health checks.

# paths./healthz.head.description
Returns public liveness headers without a response body.

# paths./readyz.get.description
Returns coarse public readiness status for load balancer and edge health checks.

# paths./readyz.head.description
Returns public readiness headers without a response body.

# paths./v1/.get.description
Returns the public HAL discovery document for bootstrapping Veilty API clients.

# paths./v1/accounts.get.description
Lists accounts available to the current actor.

# paths./v1/accounts/{accountId}/catalogs/{catalogId}/resources/{resourc.get.description
Lists account catalog resource filter links.

# paths./v1/accounts/{accountId}/catalogs/{catalogId}/resources/{resourc.get.summary
List account catalog resource filter links

# paths./v1/accounts/{accountId}/catalogs/{catalogId}/resources/{resourc.post.description
Creates account catalog resource filter link.

# paths./v1/accounts/{accountId}/catalogs/{catalogId}/resources/{resourc.post.summary
Create account catalog resource filter link

# paths./v1/accounts/{accountId}/catalogs/{catalogId}/resources/{resourc.delete.description
Deletes account catalog resource filter link.

# paths./v1/accounts/{accountId}/catalogs/{catalogId}/resources/{resourc.delete.summary
Delete account catalog resource filter link

# paths./v1/accounts/{accountId}/catalogs/{catalogId}/resources/{resourc.get.description
Returns account catalog resource filter link.

# paths./v1/accounts/{accountId}/catalogs/{catalogId}/resources/{resourc.get.summary
Read account catalog resource filter link

# paths./v1/accounts/{accountId}/catalogs/{catalogId}/resources/{resourc.patch.description
Updates account catalog resource filter link.

# paths./v1/accounts/{accountId}/catalogs/{catalogId}/resources/{resourc.patch.summary
Update account catalog resource filter link

# paths./v1/accounts/{accountId}/catalogs/{catalogId}/resources/{resourc.get.description
Lists account catalog resource filter set links.

# paths./v1/accounts/{accountId}/catalogs/{catalogId}/resources/{resourc.get.summary
List account catalog resource filter set links

# paths./v1/accounts/{accountId}/catalogs/{catalogId}/resources/{resourc.get.description
Lists account catalog resource rule set links.

# paths./v1/accounts/{accountId}/catalogs/{catalogId}/resources/{resourc.get.summary
List account catalog resource rule set links

# paths./v1/accounts/{accountId}/filter-sets/{filterSetId}/endpoint-link.get.description
Lists account filter set endpoint links.

# paths./v1/accounts/{accountId}/filter-sets/{filterSetId}/resource-link.get.description
Lists account filter set resource links.

# paths./v1/accounts/{accountId}/filter-sets/{filterSetId}/resource-link.post.description
Creates account filter set resource link.

# paths./v1/accounts/{accountId}/filter-sets/{filterSetId}/resource-link.post.description
Submits account filter set resource link batch.

# paths./v1/accounts/{accountId}/filter-sets/{filterSetId}/resource-link.post.summary
Submit account filter set resource link batch

# paths./v1/accounts/{accountId}/filter-sets/{filterSetId}/resource-link.delete.description
Deletes account filter set resource link.

# paths./v1/accounts/{accountId}/filter-sets/{filterSetId}/resource-link.get.description
Returns account filter set resource link.

# paths./v1/accounts/{accountId}/filter-sets/{filterSetId}/resource-link.patch.description
Updates account filter set resource link.

# paths./v1/accounts/{accountId}/rule-sets/{ruleSetId}/resource-links/ba.post.description
Submits account rule set resource link batch.

# paths./v1/accounts/{accountId}/rule-sets/{ruleSetId}/resource-links/ba.post.summary
Submit account rule set resource link batch

# paths./v1/auth/forgot-password.post.description
Rejects direct password reset requests while waitlist onboarding is active.

# paths./v1/auth/health.get.description
Returns public authentication surface health for client diagnostics.

# paths./v1/auth/me.get.description
Returns the authenticated principal visible to the auth surface.

# paths./v1/auth/passkey/login.post.description
Completes a passkey login ceremony and returns authenticated session material.

# paths./v1/auth/passkey/login/options.post.description
Creates passkey login challenge options for a browser authentication ceremony.

# paths./v1/auth/passkey/register.post.description
Completes a passkey registration ceremony for an authenticated user.

# paths./v1/auth/passkey/register/options.post.description
Creates passkey registration challenge options for a browser credential ceremony.

# paths./v1/auth/register.post.description
Rejects direct public user registration while waitlist onboarding is active.

# paths./v1/auth/reset-password.post.description
Rejects direct password reset completion while waitlist onboarding is active.

# paths./v1/auth/revoke.post.description
Revokes an issued refresh token for the authenticated session.

# paths./v1/auth/social.post.description
Rejects direct social registration while waitlist onboarding is active.

# paths./v1/auth/token.post.description
Issues an access token for a validated credential exchange.

# paths./v1/health/dependency/database.get.description
Lists protected health dependency database.

# paths./v1/health/dependency/database.get.summary
List protected health dependency database

# paths./v1/health/quarantine.get.description
Lists protected health quarantine probes.

# paths./v1/health/readiness.get.description
Lists protected health readiness probes.

# paths./v1/me.delete.description
Deletes the current authenticated user's self-service account identity after precondition checks.

# paths./v1/me.get.description
Returns the current authenticated user's self-service profile and memberships.

# paths./v1/me.patch.description
Updates the current authenticated user's self-service profile fields.

# paths./v1/me/analytics/dns/metrics.get.description
Lists self-service analytics DNS metrics.

# paths./v1/me/endpoints/{endpointId}/apple-profile.get.description
Returns self-service endpoint Apple provisioning profile.

# paths./v1/me/endpoints/{endpointId}/apple-profile.get.summary
Read self-service endpoint Apple provisioning profile

# paths./v1/me/endpoints/{endpointId}/filter-set-links.get.description
Lists self-service endpoint filter set links.

# paths./v1/me/endpoints/{endpointId}/filter-set-links.get.summary
List self-service endpoint filter set links

# paths./v1/me/endpoints/{endpointId}/rule-set-links.get.description
Lists self-service endpoint rule set links.

# paths./v1/me/endpoints/{endpointId}/rule-set-links.get.summary
List self-service endpoint rule set links

# paths./v1/me/filter-sets/{filterSetId}/filter-links.get.description
Lists self-service filter set filter links.

# paths./v1/me/filter-sets/{filterSetId}/filter-links.get.summary
List self-service filter set filter links

# paths./v1/me/filter-sets/{filterSetId}/filter-links.post.description
Creates self-service filter set filter link.

# paths./v1/me/filter-sets/{filterSetId}/filter-links.post.summary
Create self-service filter set filter link

# paths./v1/me/filter-sets/{filterSetId}/filter-links/{linkId}.delete.description
Deletes self-service filter set filter link.

# paths./v1/me/filter-sets/{filterSetId}/filter-links/{linkId}.delete.summary
Delete self-service filter set filter link

# paths./v1/me/filter-sets/{filterSetId}/filter-links/{linkId}.get.description
Returns self-service filter set filter link.

# paths./v1/me/filter-sets/{filterSetId}/filter-links/{linkId}.get.summary
Read self-service filter set filter link

# paths./v1/me/filter-sets/{filterSetId}/filter-links/{linkId}.patch.description
Updates self-service filter set filter link.

# paths./v1/me/filter-sets/{filterSetId}/filter-links/{linkId}.patch.summary
Update self-service filter set filter link

# paths./v1/me/filter-sets/{filterSetId}/resource-links.get.description
Lists self-service filter set resource links.

# paths./v1/me/filter-sets/{filterSetId}/resource-links.get.summary
List self-service filter set resource links

# paths./v1/me/filter-sets/{filterSetId}/resource-links.post.description
Creates self-service filter set resource link.

# paths./v1/me/filter-sets/{filterSetId}/resource-links.post.summary
Create self-service filter set resource link

# paths./v1/me/filter-sets/{filterSetId}/resource-links/batch.post.description
Submits self-service filter set resource link batch.

# paths./v1/me/filter-sets/{filterSetId}/resource-links/batch.post.summary
Submit self-service filter set resource link batch

# paths./v1/me/filter-sets/{filterSetId}/resource-links/{linkId}.delete.description
Deletes self-service filter set resource link.

# paths./v1/me/filter-sets/{filterSetId}/resource-links/{linkId}.delete.summary
Delete self-service filter set resource link

# paths./v1/me/filter-sets/{filterSetId}/resource-links/{linkId}.get.description
Returns self-service filter set resource link.

# paths./v1/me/filter-sets/{filterSetId}/resource-links/{linkId}.get.summary
Read self-service filter set resource link

# paths./v1/me/filter-sets/{filterSetId}/resource-links/{linkId}.patch.description
Updates self-service filter set resource link.

# paths./v1/me/filter-sets/{filterSetId}/resource-links/{linkId}.patch.summary
Update self-service filter set resource link

# paths./v1/me/filter-sets/{filterSetId}/resources.get.description
Lists self-service filter set resources.

# paths./v1/me/rule-sets/{ruleSetId}/resource-links.get.description
Lists self-service rule set resource links.

# paths./v1/me/rule-sets/{ruleSetId}/resource-links.get.summary
List self-service rule set resource links

# paths./v1/me/rule-sets/{ruleSetId}/resource-links/{linkId}.get.description
Returns self-service rule set resource link.

# paths./v1/me/rule-sets/{ruleSetId}/resource-links/{linkId}.get.summary
Read self-service rule set resource link

# paths./v1/openapi.json.get.description
Returns the OpenAPI 3.1 reference document for Veilty API clients.

# paths./v1/tenants.get.description
Lists tenants available to the current actor.

# paths./v1/tenants/{tenantId}/endpoints/{endpointId}/apple-profile.get.description
Returns tenant endpoint Apple provisioning profile.

# paths./v1/tenants/{tenantId}/endpoints/{endpointId}/apple-profile.get.summary
Read tenant endpoint Apple provisioning profile

# paths./v1/tenants/{tenantId}/endpoints/{endpointId}/filter-set-links.post.description
Creates tenant endpoint filter set link.

# paths./v1/tenants/{tenantId}/endpoints/{endpointId}/filter-set-links/{.delete.description
Deletes tenant endpoint filter set link.

# paths./v1/tenants/{tenantId}/endpoints/{endpointId}/filter-set-links/{.get.description
Returns tenant endpoint filter set link.

# paths./v1/tenants/{tenantId}/endpoints/{endpointId}/filter-set-links/{.patch.description
Updates tenant endpoint filter set link.

# paths./v1/tenants/{tenantId}/endpoints/{endpointId}/transitions/emerge.post.description
Marks emergency state on tenant endpoint.

# tags[].description
Public API discovery documents for bootstrapping clients.

# tags[].description
Machine-readable reference document for client tooling.

# tags[].description
Public and protected health probes for service availability.

# tags[].description
Authentication, token, registration, password reset, and passkey ceremonies.

# tags[].description
Account records, plans, limits, and account-level billing or quota controls.

# tags[].description
Tenant records, tenant lifecycle transitions, and account-to-tenant membership.

# tags[].description
Account and tenant user administration, membership, roles, and credentials.

# tags[].description
Session listing, inspection, and revocation for authenticated users.

# tags[].description
Passkey registration, lookup, and credential lifecycle operations.

# tags[].description
Catalog libraries, resources, links, publication state, and catalog attachments.

# tags[].description
Filter set libraries, resource links, endpoint links, and filter attachments.

# tags[].description
Rule set libraries, rule links, resource links, endpoint links, and transitions.

# tags[].description
Resolver profile libraries, profile options, and endpoint profile assignments.

# tags[].description
Managed DNS endpoints, endpoint state transitions, and endpoint policy links.

# tags[].description
Point-of-presence registration, lookup, and POP-local DNS log access.

# tags[].description
DNS analytics metrics and raw-log read surfaces.

# tags[].description
Asynchronous job status and cancellation operations.