HTTP Provider

The HTTP provider allows you to query any HTTP endpoint that returns JSON data for verification metrics.

Configuration

provider:
  type: http
  url: "http://{{.resource.name}}/health"
  method: GET
  headers:
    Authorization: "Bearer {{.variables.health_token}}"
  timeout: 30s

Properties

provider.type

string

required

Must be "http".

provider.url

string

required

HTTP endpoint URL. Supports Go templates for dynamic URLs (e.g., http://{{.resource.name}}/health).

provider.method

string

default:"GET"

HTTP method. Options: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS.

provider.headers

object

HTTP headers to include in the request. Values support Go templates (e.g., Authorization: "Bearer {{.variables.token}}").

provider.body

string

Request body for POST/PUT/PATCH requests. Supports Go templates for dynamic content.

provider.timeout

string

default:"30s"

Request timeout duration. Use format like 30s, 1m, 500ms.

Supported HTTP Methods

GET (default)
POST
PUT
PATCH
DELETE
HEAD
OPTIONS

Response Data Available in CEL

The HTTP provider makes the following data available in your CEL success conditions:

result.ok - true if status code is 2xx
result.statusCode - HTTP status code (e.g., 200, 404, 500)
result.body - Response body as string
result.json - Parsed JSON response (if response is valid JSON)
result.headers - Response headers as an object
result.duration - Request duration in milliseconds

Example Success Conditions

# Status code check
successCondition: result.ok

# JSON field check
successCondition: result.json.healthy == true

# Numeric threshold
successCondition: result.json.error_rate < 0.01

# Combined conditions
successCondition: result.ok && result.json.ready == true

# Check specific status code
successCondition: result.statusCode == 200

# Check response time
successCondition: result.duration < 500

Examples

Basic Health Check

provider:
  type: http
  url: "http://{{.resource.name}}/health"
  method: GET
successCondition: result.ok && result.json.status == "healthy"

POST Request with Body

provider:
  type: http
  url: "http://smoke-test-runner/run"
  method: POST
  headers:
    Content-Type: "application/json"
  body: |
    {
      "service": "{{.resource.name}}",
      "version": "{{.version.tag}}",
      "environment": "{{.environment.name}}"
    }
successCondition: result.json.status == "passed"

Authenticated Request

provider:
  type: http
  url: "http://api.example.com/health"
  method: GET
  headers:
    Authorization: "Bearer {{.variables.health_token}}"
    X-API-Key: "{{.variables.api_key}}"
successCondition: result.ok

Custom Timeout

provider:
  type: http
  url: "http://slow-service/health"
  method: GET
  timeout: 60s
successCondition: result.ok

Template Variables

The HTTP provider supports Go templates in the url, headers, and body fields:

# Resource information
{{.resource.name}}
{{.resource.identifier}}
{{.resource.kind}}

# Environment information
{{.environment.name}}
{{.environment.id}}

# Deployment information
{{.deployment.name}}
{{.deployment.slug}}

# Version information
{{.version.tag}}
{{.version.id}}

# Custom variables (from deployment variables)
{{.variables.my_variable}}
{{.variables.health_token}}

Best Practices

Use HTTPS for production endpoints to ensure secure communication
Set appropriate timeouts based on your service’s expected response time
Handle authentication using deployment variables for sensitive tokens
Validate JSON responses by checking result.json exists before accessing fields
Use meaningful success conditions that check both status codes and response content

​Configuration

​Properties

​Supported HTTP Methods

​Response Data Available in CEL

​Example Success Conditions

​Examples

​Basic Health Check

​POST Request with Body

​Authenticated Request

​Custom Timeout

​Template Variables

​Best Practices

Configuration

Properties

Supported HTTP Methods

Response Data Available in CEL

Example Success Conditions

Examples

Basic Health Check

POST Request with Body

Authenticated Request

Custom Timeout

Template Variables

Best Practices