ktor-client-core/io.ktor.client/HttpClientConfig

HttpClientConfig

class HttpClientConfig<T : HttpClientEngineConfig>

A mutable HttpClient configuration used to adjust settings, install plugins and interceptors.

This configuration can be provided as a lambda in the HttpClient constructor or the HttpClient.config builder:

val client = HttpClient { // HttpClientConfig<Engine>()
    // Configure engine settings
    engine { // HttpClientEngineConfig
        threadsCount = 4
        pipelining = true
    }

    // Install and configure plugins
    install(ContentNegotiation) {
        json()
    }

    // Configure default request parameters
    defaultRequest {
        url("https://api.example.com")
        header("X-Custom-Header", "value")
    }

    // Configure client-wide settings
    expectSuccess = true
    followRedirects = true
}

Configuring HttpClientEngine

If the engine is specified explicitly, engine-specific properties will be available in the engine block:

val client = HttpClient(CIO) { // HttpClientConfig<CIOEngineConfig>.() -> Unit
    engine { // CIOEngineConfig.() -> Unit
        // engine specific properties
    }
}

Learn more about the client's configuration from Creating and configuring a client.

Constructors

HttpClientConfig

constructor()

Properties

developmentMode

var ~~developmentMode~~: Boolean

Development mode is no longer required all functionality is enabled by default. The property is safe to remove.

expectSuccess

var expectSuccess: Boolean

Terminates HttpClient.receivePipeline if the status code is not successful (>=300). Learn more from Response validation.

followRedirects

var followRedirects: Boolean

Specifies whether the client redirects to URLs provided in the Location header. You can disable redirections by setting this property to false.

useDefaultTransformers

var useDefaultTransformers: Boolean

Enables body transformations for many common types like String, ByteArray, ByteReadChannel, etc. These transformations are applied to the request and response bodies.