HTTPEndpoint spec

The basic spec for a Dapr HTTPEndpoint resource

The HTTPEndpoint is a Dapr resource that is used to enable the invocation of non-Dapr endpoints from a Dapr application.

Format

  1. apiVersion: dapr.io/v1alpha1
  2. kind: HTTPEndpoint
  3. metadata:
  4.   name: <NAME>  
  5. spec:
  6.   baseUrl: <REPLACE-WITH-BASEURL> # Required. Use "http://" or "https://" prefix.
  7.   headers: # Optional
  8.   - name: <REPLACE-WITH-A-HEADER-NAME>
  9.     value: <REPLACE-WITH-A-HEADER-VALUE>
  10.   - name: <REPLACE-WITH-A-HEADER-NAME>
  11.     secretKeyRef:
  12.       name: <REPLACE-WITH-SECRET-NAME>
  13.       key: <REPLACE-WITH-SECRET-KEY>
  14.   clientTLS:
  15.     rootCA:
  16.       secretKeyRef:
  17.         name: <REPLACE-WITH-SECRET-NAME>
  18.         key: <REPLACE-WITH-SECRET-KEY>
  19.     certificate:
  20.       secretKeyRef:
  21.         name: <REPLACE-WITH-SECRET-NAME>
  22.         key: <REPLACE-WITH-SECRET-KEY>
  23.     privateKey:
  24.       secretKeyRef:
  25.         name: <REPLACE-WITH-SECRET-NAME>
  26.         key: <REPLACE-WITH-SECRET-KEY>
  27. scopes: # Optional
  28.   - <REPLACE-WITH-SCOPED-APPIDS>
  29. auth: # Optional
  30.   secretStore: <REPLACE-WITH-SECRETSTORE>

Spec fields

FieldRequiredDetailsExample
baseUrlYBase URL of the non-Dapr endpoint“https://api.github.com“, “http://api.github.com“
headersNHTTP request headers for service invocationname: “Accept-Language” value: “en-US”
name: “Authorization” secretKeyRef.name: “my-secret” secretKeyRef.key: “myGithubToken”
clientTLSNEnables TLS authentication to an endpoint with any standard combination of root certificate, client certificate and private key

Learn how to invoke non-Dapr endpoints.

Last modified March 21, 2024: Merge pull request #4082 from newbe36524/v1.13 (f4b0938)