@accelerated-software-development/caddy-api-client - v0.4.3
    Preparing search index...

      @accelerated-software-development/caddy-api-client - v0.4.3

      Namespaces

      caddySecurity

      Classes

      CaddyApiClientError
      CaddyApiError
      CaddyClient
      CertificateManager
      DomainAlreadyExistsError
      DomainNotFoundError
      MitmproxyManager
      MitmproxyNotInstalledError
      MitmproxyStartError
      NetworkError
      TimeoutError
      ValidationError

      Interfaces

      AccessListEntry
      AuthenticationHandler
      AuthenticationPortal
      AuthorizationPolicy
      BasicAuthRouteOptions
      BuildAuthenticationPortalOptions
      BuildAuthenticationRouteOptions
      BuildAuthenticatorHandlerOptions
      BuildAuthorizationHandlerOptions
      BuildAuthorizationPolicyOptions
      BuildLdapIdentityStoreOptions
      BuildLocalIdentityStoreOptions
      BuildOAuth2ProviderOptions
      BuildOidcProviderOptions
      BuildProtectedRouteOptions
      BuildSecurityAppOptions
      BuildSecurityConfigOptions
      CaddyClientOptions
      CaddyRoute
      CaddyRouteMatcher
      CertificateInfo
      CertificateWithMetadata
      CookieOptions
      CopyResponseHandler
      CopyResponseHeadersHandler
      CryptoKeyConfig
      EnableOptions
      EncodeHandler
      ErrorHandler
      ErrorRouteOptions
      ExpirationCheckResult
      FileServerHandler
      FileServerRouteOptions
      GenericHandler
      HeadersHandler
      HealthCheckRouteOptions
      HealthRouteOptions
      HostRouteOptions
      IframeProxyRouteOptions
      InterceptHandler
      InvokeHandler
      LdapIdentityStore
      LdapServerConfig
      LoadBalancerRouteOptions
      LoadConfigOptions
      LocalIdentityStore
      LogAppendHandler
      MapHandler
      MapHandlerOptions
      MitmproxyInstance
      MitmwebOptions
      MitmwebStatus
      OAuth2IdentityProvider
      OidcIdentityProvider
      PathRouteOptions
      PortalUiOptions
      PushHandler
      RequestBodyHandler
      RequestBodyHandlerOptions
      ReverseProxyHandler
      RewriteHandler
      RewriteRouteOptions
      RotateCertificateOptions
      RotationResult
      SecurityApp
      SecurityAuthenticatorHandler
      SecurityAuthorizationHandler
      SecurityAuthorizerProvider
      SecurityConfig
      SecurityTemplate
      ServiceRegistration
      ServiceRouteOptions
      ServiceStatus
      StaticResponseHandler
      SubrouteHandler
      TemplatesHandler
      TemplatesRouteOptions
      TemplateVariable
      TlsConnectionPolicy
      TlsConnectionPolicyOptions
      TracingHandler
      TracingHandlerOptions
      UpstreamStatus
      VarsHandler
      VarsHandlerOptions
      WebSocketProxyRouteOptions

      Type Aliases

      CaddyAdapter
      CaddyRouteHandler
      HttpMethod
      IdentityStore
      RedirectStatusCode
      SecurityHandler

      Variables

      ActiveHealthChecksSchema
      AdaptOptionsSchema
      AddDomainWithAutoTlsOptionsSchema
      AddDomainWithTlsOptionsSchema
      adminConfigSchema
      AuthenticationHandlerSchema
      AuthenticationPortalSchema
      AuthorizationPolicySchema
      BasicAuthOptionsSchema
      CaddyAdapterSchema
      CaddyClientOptionsSchema
      CaddyDurationSchema
      CaddyHandlerSchema
      CaddyRouteHandlerSchema
      CaddyRouteMatcherSchema
      CaddyRouteSchema
      configSchema
      CopyResponseHandlerSchema
      CopyResponseHeadersHandlerSchema
      DeleteDomainOptionsSchema
      DialAddressSchema
      DomainSchema
      durationSchema
      EncodeHandlerSchema
      ErrorHandlerSchema
      ExtendedRouteMatcherSchema
      FileServerHandlerSchema
      FrameOptionsSchema
      HeaderRegexpSchema
      HeadersHandlerSchema
      HealthCheckRouteOptionsSchema
      HealthChecksSchema
      HostRouteOptionsSchema
      HTTP_ALPN_PROTOCOLS
      HTTP1_ALPN_PROTOCOLS
      HTTP2_ALPN_PROTOCOLS
      HttpMethodSchema
      IdentityStoreSchema
      InterceptHandlerSchema
      InvokeHandlerSchema
      KnownCaddyHandlerSchema
      LdapIdentityStoreSchema
      LoadBalancerRouteOptionsSchema
      LoadBalancingSchema
      LocalIdentityStoreSchema
      LogAppendHandlerSchema
      loggingSchema
      MapHandlerSchema
      MatchHeaderSchema
      MatchQuerySchema
      MitmwebOptionsSchema
      MODERN_CIPHER_SUITES
      OAuth2IdentityProviderSchema
      OidcIdentityProviderSchema
      PassiveHealthChecksSchema
      PathRouteOptionsSchema
      PushHandlerSchema
      RedirectModeSchema
      RedirectStatusCodeSchema
      RequestBodyHandlerSchema
      ReverseProxyHandlerSchema
      RewriteHandlerSchema
      ROUTE_PRIORITIES
      routeListSchema
      routeSchema
      SECURITY_TEMPLATES
      SecurityAppSchema
      SecurityAuthenticatorHandlerSchema
      SecurityAuthorizationHandlerSchema
      SecurityAuthorizerProviderSchema
      SecurityConfigSchema
      SecurityHandlerSchema
      SecurityHeadersSchema
      serverSchema
      ServiceRouteOptionsSchema
      StaticResponseHandlerSchema
      SubrouteHandlerSchema
      TemplatesHandlerSchema
      TLS_1_2_CIPHER_SUITES
      TLS_1_3_CIPHER_SUITES
      TlsIssuerSchema
      TracingHandlerSchema
      UpdateDomainOptionsSchema
      UpstreamSchema
      UpstreamStatusArraySchema
      UpstreamStatusSchema
      VarsHandlerSchema
      VERSION

      Functions

      addDomainWithAutoTls
      addDomainWithTls
      autoInstallMitmproxy
      buildAuthenticationPortal
      buildAuthenticatorHandler
      buildAuthenticatorRoute
      buildAuthorizationHandler
      buildAuthorizationPolicy
      buildBasicAuthHandler
      buildCompatibleTlsPolicy
      buildCompressionHandler
      buildDnsRebindingBypassHandler
      buildErrorRoute
      buildFileServerRoute
      buildHealthCheckRoute
      buildHostRoute
      buildIframeHeadersHandler
      buildIframePermissiveHandler
      buildIframeProxyRoute
      buildIngressTagHeadersHandler
      buildLdapIdentityStore
      buildLoadBalancerRoute
      buildLocalIdentityStore
      buildMapHandler
      buildMitmproxyRoute
      buildMitmproxyRoutePair
      buildMitmproxyWebSocketRoute
      buildMitmproxyWebUiRoute
      buildModernTlsPolicy
      buildOAuth2Provider
      buildOidcProvider
      buildPathRoute
      buildProtectedRoute
      buildRedirectRoute
      buildRequestBodyHandler
      buildReverseProxyHandler
      buildRewriteHandler
      buildSecurityApp
      buildSecurityConfig
      buildSecurityHeadersHandler
      buildServiceRoutes
      buildTemplatesRoute
      buildTlsConnectionPolicy
      buildTracingHandler
      buildVarsHandler
      buildWebSocketProxyRoute
      buildWwwRedirect
      calculateRoutePriority
      createBasicAuthAccount
      createBasicAuthAccounts
      createBasicAuthRoute
      createCertificateManager
      createHealthRoute
      createLoadBalancerRoute
      createRedirectRoute
      createRewriteRoute
      createServiceRoute
      deleteDomain
      detectAdapter
      extractSerialNumber
      generateCertTag
      getDaysUntilExpiration
      getDomainConfig
      getMitmproxyVersion
      getMitmwebStatus
      getTemplateById
      getTemplatesByCategory
      hashPassword
      hashPasswordWithCaddy
      insertRouteRelative
      isCertificateExpired
      isCertificateExpiringSoon
      isMitmproxyInstalled
      listDomains
      loadCaddyfile
      loadConfig
      parseCertificate
      removeOldCertificates
      rotateCertificate
      sortRoutes
      splitCertificateBundle
      startMitmweb
      stopMitmweb
      updateDomain
      validate
      validateRouteOrdering
      verifyPassword