PackagePackagetypeA library you install and call yourself.See every one →What this type is →by SAPby SAPoriginPublished by SAP itself. A visible facet, never an input to a reading — a dormant official plugin reads exactly like a dormant independent one.See every one →
@sap-cloud-sdk/http-client
The HTTP client that carries a destination's credentials, so an outbound call inherits the authentication rather than assembling it.
DestinationsCAPDestinationscapabilityReaching a system that is not yours — an S/4HANA tenant, an on-premise service, a third-party API — without the address, the credentials or the tunnel being written into the application. The destination is the indirection, and the reason an endpoint can move without a redeploy.
Requires
SAP Destination serviceSAP Destination serviceartifactNamed as a dependency in its documentation.
Who is behind it
SAPSAPOrganisationMaintains this In the atlas: maintains 137, wrote 14@SAPmaintainerArtem KovalovPersonContributes to this In the atlas: contributes to 6@artemkovalyovSAP Cloud SDK BotPersonContributes to this In the atlas: contributes to 11@bot-sdk-jsBrigittaK307PersonContributes to this In the atlas: contributes to 12@BrigittaK307Britta VarwigPersonContributes to this In the atlas: contributes to 8@bvarwigRobert KaniaPersonContributes to this In the atlas: contributes to 6@cezaryrkChristian SchüringsPersonContributes to this In the atlas: contributes to 25@cschueringsDaniel KullmannPersonContributes to this In the atlas: contributes to 6@daniel-kullmannDavid KnaackPersonContributes to this In the atlas: contributes to 13, wrote 1@davidkna-sapDeeksha SinhaPersonContributes to this In the atlas: contributes to 12@deekshas8Deni DajaPersonContributes to this In the atlas: contributes to 6@denidaja38 contributors
Before choosing this
crawled
Conditions
LicenceSAP Developer License Agreement 3.2 CAP§ 1from DestinationsA destination used by a covered CAP application sends SAP product data to a non-SAP product rather than only addressing a remote endpoint.
§ 1License. Productive customer applications are limited to SAP BTP or another SAP-licensed platform, and mass extraction to a non-SAP product is restricted except where solely required for SAP interoperability.
A destination is configuration, not the deciding boundary. The licence becomes material when the resulting data flow is extraction into a non-SAP product, so the target and purpose need review.
declared, Where the library runs once installed: inside its host (loaded into the CAP application, installed into the ABAP system, loaded by the UI5 application), in a program of your own, or only at build time.
Distributed through
npm
declared, How it is installed, as its documentation tells a user to get it., read npm install @sap-cloud-sdk/http-client — @sap-cloud-sdk/http-client — README, 2026-10-18
Connections4
Group by
NodeRelationConditionBasis
Functional1
DestinationsDestinationscapabilityReaching remote systems without addresses or credentials in the codeSAP and community, unassessed
→provides
none
authored
provides Destinations
Functional, authored
Reaching remote systems without addresses or credentials in the code
Technical3
SAP Destination serviceSAP Destination serviceserviceNamed, credentialed addresses of other systems resolved at runtimesap official, btp
→needs
none
authored
needs SAP Destination service
Technical, authored
Named, credentialed addresses of other systems resolved at runtime
@expertum/cap-email-plugin@expertum/cap-email-plugincds-pluginAnnotation-driven mail on CAP entity lifecycle eventsindependent, cap
←optionally used by
if The project installs it; peerDependenciesMeta marks it optional
optionally used by @expertum/cap-email-plugin
Technical, derived, through inverted from its requires edge
If
The project installs it; peerDependenciesMeta marks it optional.
For
Declared an optional peer dependency at ^4, beside @sap-cloud-sdk/resilience, so it is present only where the project installs it.
Basis
“"@sap-cloud-sdk/http-client": "^4"”@expertum/cap-email-plugin — package.json on main, checked
derived
optionally used by @expertum/cap-email-plugin
Technical, derived, through inverted from its requires edge
If
The project installs it; peerDependenciesMeta marks it optional.
For
Declared an optional peer dependency at ^4, beside @sap-cloud-sdk/resilience, so it is present only where the project installs it.
Basis
“"@sap-cloud-sdk/http-client": "^4"”@expertum/cap-email-plugin — package.json on main, checked
Annotation-driven mail on CAP entity lifecycle events
@sap/cds@sap/cdspackageCAP Node.js runtimesap official, cap
←optionally used by
if A remote service call needs on-premise connectivity or an authentication type the native fetch client does not support; used by default whenever the package is installed
optionally used by @sap/cds
Technical, derived, through inverted from its requires edge
If
A remote service call needs on-premise connectivity or an authentication type the native fetch client does not support; used by default whenever the package is installed.
For
Resolving destinations that the runtime's own fetch client does not cover; installing it makes the runtime use it instead.
Basis
“Install @sap-cloud-sdk/http-client in your project, to have that used automatically instead of the built-in native fetch client. Do so if you use an authentication type that's not supported yet — for example, OnPremise connectivity.”CAP Release Notes — September 2026, Destinations w/o Cloud SDK, checked
derived
optionally used by @sap/cds
Technical, derived, through inverted from its requires edge
If
A remote service call needs on-premise connectivity or an authentication type the native fetch client does not support; used by default whenever the package is installed.
For
Resolving destinations that the runtime's own fetch client does not cover; installing it makes the runtime use it instead.
Basis
“Install @sap-cloud-sdk/http-client in your project, to have that used automatically instead of the built-in native fetch client. Do so if you use an authentication type that's not supported yet — for example, OnPremise connectivity.”CAP Release Notes — September 2026, Destinations w/o Cloud SDK, checked
@sap-cloud-sdk/http-clientpackageThe HTTP client that carries a destination's credentials, so an outbound call inherits the authentication rather than assembling it.sap official, cap
SAP Destination serviceserviceNamed, credentialed addresses of other systems, resolved at runtime — so an application holds no URL and no secret of its own, and the same code reaches a different system in every landscape.sap official, btp
@sap-cloud-sdk/http-client → SAP Destination serviceDocumented only
This package contains the generic http-client functionality of the SAP Cloud SDK as well as the Cloud Platform abstractions.
The generic http-client adds SAP infrastructure specific functionality on top of a standard HTTP Client. The client handles connectivity related issues such as destination lookup, connections to SAP S/4HANA On-premise and web proxies.
Installation
$ npm install @sap-cloud-sdk/http-client
Usage
To make a request, use the executeHttpRequest function.
The recommended way to get in touch with us is to create an issue on GitHub.
Select the issue category Bug, Feature, or Question depending on the nature of your request.
We try to provide fixes, features and answers as soon as possible.
Contribute
If you would like to contribute to the SAP Cloud SDK, please make yourself familiar with our contributing guidelines and follow the given instructions.
e8f8134: [fix] Export ./internal.js named export in package.json for compatibility.
Please migrate to the new named export ./internal, the old export is deprecated and will be removed in the next major release.
32aab37: [feat] A new agentOptions property on Destination allows configuring the underlying HTTP(S) agent (e.g. keepAlive, timeout) without constructing an agent manually.
d54ba5a: [Improvement] Cache custom http and https agents and enable the keep-alive option by default.
d54ba5a: [Improvement] Use node's global http/https agent unless a custom agent is required by the destination configuration.
Patch Changes
67e1c53: [Fixed Issue] Warn when the CSRF token fetch URL has a different host than the request URL, as sensitive headers would be forwarded to the cross-host endpoint.
7ea34ce: [Fixed Issue] Improve handling of missing zlib-module in the compress() middleware and lazy-load it only when needed.
To compress requests in the browser, ensure that a suitable polyfill is provided.
cbed72f: [Improvement] Add signal property to CustomRequestConfig and HttpRequestConfigBase type definition to document AbortSignal support for cancelling HTTP requests.
f5715de: [Improvement] Add request compression middleware.
Use the compress() middleware to compress HTTP request payloads using gzip, brotli, deflate, or zstd algorithms.
Supports multiple compression modes: auto (size-based), passthrough (pre-compressed), or forced compression.
8f54207b6: [Fixed Issue] Do not set default tenant ID in the context of middlewares, if the tenant ID is unknown. In those cases it will be undefined from now on.
56c3f70f4: [Fixed Issue] Forward the user JWT irrespective of the destination authentication type when forwardAuthToken is set to true on a destination
73ff0ab03: [Fixed Issue] Improve CSRF token fetching for large requests.
fde964e37: [Compatibility Note] Remove the options timeout and enableCircuitBreaker from all BTP service interactions i.e. destination and token fetching.
fde964e37: [Compatibility Note] Switch the compilerOptions.module to Node16 instead of CommonJS for better interoperability with ES modules. See the TypeScript handbook for technical details if needed.
fde964e37: [Compatibility Note] Remove timeout() method from the request builders and the timeout options from the executeHttpRequest() function.
Visit the documentation portal to see how to add a timeout using middlewares.
fde964e37: [Compatibility Note] Removed overload of executeHttpRequest
The overload, that accepted HttpRequestConfigWithOrigin as a parameter, is removed and replaced by the function executeHttpRequestWithOrigin.
fde964e37: [Compatibility Note]] The url property in Destination is now optional as destinations of type MAIL do not have a URL.
Minor Changes
fde964e37: [New Functionality] The request configuration used in the final request is now part of the middleware context.
User can implement middlewares to change request properties like headers using this reference in the middleware context.
The request configuration contains the url, headers and all other properties of the HTTP request.
fde964e37: [New Functionality] Introduce the middleware on the request builders and http-client.
Visit the documentation portal to see how to use middlewares.
e44c214a: [Fixed Issue] Fix the executeHttpRequest/executeHttpRequestWithOrigin function, so the warning is only shown when overwriting headers by using custom headers.
e46bb51d: [Improvement] Make requestConfig of OriginOptions optional.
9481ec69: [Fixed Issue] Fix the executeHttpRequest function, so it accepts the same parameters as in version 1.
[Compatibility Note] Deprecate one overload of the executeHttpRequest function, that accepts HttpRequestConfigWithOrigin as a parameter. Use the new function executeHttpRequestWithOrigin as replacement.
[New Functionality] Support defining header options and query parameter options with origins.
04726a35: [Improvement] Reduce default log output on the info level significantly.
[Compatibility Note] Only log the successful retrieval of destinations on theinfo log level, log everything else is on the debug or warn level.
DestinationsDestinationscapabilityReaching a system that is not yours — an S/4HANA tenant, an on-premise service, a third-party API — without the address, the credentials or the tunnel being written into the application. The destination is the indirection, and the reason an endpoint can move without a redeploy.SAP and community, unassessed
SAP Destination serviceSAP Destination serviceserviceNamed, credentialed addresses of other systems, resolved at runtime — so an application holds no URL and no secret of its own, and the same code reaches a different system in every landscape.sap official, btpNamed, credentialed addresses of other systems resolved at runtime
com.sap.cds:cds-feature-remote-odatacom.sap.cds:cds-feature-remote-odatapackageA CAP Java feature for consuming remote OData V2 and V4 services as Remote Services, translating CQN queries into OData requests against a destination or a service binding.sap official, capRemote Services for consuming OData V2 and V4 APIs in CAP Java
com.sap.cds:cds-integration-cloud-sdkcom.sap.cds:cds-integration-cloud-sdkpackageA CAP Java feature that integrates the SAP Cloud SDK, so features such as remote OData and enterprise messaging resolve a destination or service binding and reach a remote REST-based service.sap official, capSAP Cloud SDK integration for remote REST services in CAP Java
capire/s4capire/s4packageA pre-built integration package for SAP S/4HANA, holding the imported service definitions a CAP project would otherwise generate for itself.sap official, capPrebuilt SAP S/4HANA integration package for CAP projects
cdsecdsepackageResolves a destination from a CAP project's own configuration, then makes the outbound call with axios: the url, the method and the body are written at the call site.independent, capDestination resolution and axios calls from CAP configuration
@sap/cds@sap/cdspackageThe CAP Node.js runtime, which compiles the CDS model, serves the services declared in it, answers generic requests before any handler runs, and loads every cds-plugin.sap official, capCAP Node.js runtime
@sap-cloud-sdk/connectivity@sap-cloud-sdk/connectivitypackageDestination lookup and the connectivity proxy — the package that turns a destination name into a reachable endpoint with credentials attached.sap official, capDestination lookup and connectivity proxy for the Cloud SDK
@sap-cloud-sdk/odata-common@sap-cloud-sdk/odata-commonpackageThe shared machinery under the SDK's OData and OpenAPI client generators; a dependency of the generated clients rather than something written against directly.sap official, capShared machinery under the Cloud SDK's OData and OpenAPI clients
@sap-cloud-sdk/openapi@sap-cloud-sdk/openapipackageGenerated OpenAPI clients for the Cloud SDK, so a REST API described by a specification is called through typed functions.sap official, capGenerated OpenAPI clients for the Cloud SDK
@sap-cloud-sdk/resilience@sap-cloud-sdk/resiliencepackageTimeouts, retries and circuit breaking around a remote call, so one slow downstream system does not take the application with it.sap official, capTimeouts, retries and circuit breaking around remote calls
@sap-cloud-sdk/util@sap-cloud-sdk/utilpackageGeneral utilities shared across the Cloud SDK packages — a dependency, not a thing to reach for on its own.sap official, capGeneral utilities shared across the Cloud SDK packages
@sapmentors/cds-scp-api@sapmentors/cds-scp-apipackageA Node module for CAP that calls an external API through a destination instead of a hardcoded endpoint, taking its address, credentials and on-premise tunnel from the SAP Destination and Connectivity services.community org, capNode module for CAP calling external APIs through a destination
