getHealthchecks

Cloudflare v6.13.0, Jan 21 26

Viewing docs for Cloudflare v6.13.0
published on Wednesday, Jan 21, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-cloudflare

Viewing docs for Cloudflare v6.13.0
published on Wednesday, Jan 21, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-cloudflare

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const exampleHealthchecks = cloudflare.getHealthchecks({
    zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
});

import pulumi
import pulumi_cloudflare as cloudflare

example_healthchecks = cloudflare.get_healthchecks(zone_id="023e105f4ecef8ad9ca31a8372d0c353")

package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.LookupHealthchecks(ctx, &cloudflare.LookupHealthchecksArgs{
			ZoneId: "023e105f4ecef8ad9ca31a8372d0c353",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var exampleHealthchecks = Cloudflare.GetHealthchecks.Invoke(new()
    {
        ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetHealthchecksArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var exampleHealthchecks = CloudflareFunctions.getHealthchecks(GetHealthchecksArgs.builder()
            .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
            .build());

    }
}

variables:
  exampleHealthchecks:
    fn::invoke:
      function: cloudflare:getHealthchecks
      arguments:
        zoneId: 023e105f4ecef8ad9ca31a8372d0c353

Using getHealthchecks

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getHealthchecks(args: GetHealthchecksArgs, opts?: InvokeOptions): Promise<GetHealthchecksResult>
function getHealthchecksOutput(args: GetHealthchecksOutputArgs, opts?: InvokeOptions): Output<GetHealthchecksResult>

def get_healthchecks(max_items: Optional[int] = None,
                     zone_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetHealthchecksResult
def get_healthchecks_output(max_items: Optional[pulumi.Input[int]] = None,
                     zone_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetHealthchecksResult]

func LookupHealthchecks(ctx *Context, args *LookupHealthchecksArgs, opts ...InvokeOption) (*LookupHealthchecksResult, error)
func LookupHealthchecksOutput(ctx *Context, args *LookupHealthchecksOutputArgs, opts ...InvokeOption) LookupHealthchecksResultOutput

> Note: This function is named LookupHealthchecks in the Go SDK.

public static class GetHealthchecks 
{
    public static Task<GetHealthchecksResult> InvokeAsync(GetHealthchecksArgs args, InvokeOptions? opts = null)
    public static Output<GetHealthchecksResult> Invoke(GetHealthchecksInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetHealthchecksResult> getHealthchecks(GetHealthchecksArgs args, InvokeOptions options)
public static Output<GetHealthchecksResult> getHealthchecks(GetHealthchecksArgs args, InvokeOptions options)

fn::invoke:
  function: cloudflare:index/getHealthchecks:getHealthchecks
  arguments:
    # arguments dictionary

The following arguments are supported:

ZoneId string: Identifier
MaxItems int: Max items to fetch, default: 1000

ZoneId string: Identifier
MaxItems int: Max items to fetch, default: 1000

zoneId String: Identifier
maxItems Integer: Max items to fetch, default: 1000

zoneId string: Identifier
maxItems number: Max items to fetch, default: 1000

zone_id str: Identifier
max_items int: Max items to fetch, default: 1000

zoneId String: Identifier
maxItems Number: Max items to fetch, default: 1000