Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Zenduty Provider
  4. API Docs
  5. getHeartbeats
Viewing docs for zenduty 2.2.0
published on Friday, Oct 30, 2026 by zenduty
Schema (JSON)
zenduty/terraform-provider-zenduty

zenduty.getHeartbeats

zenduty
Viewing docs for zenduty 2.2.0
published on Friday, Oct 30, 2026 by zenduty
Schema (JSON)
zenduty/terraform-provider-zenduty

    zenduty.getHeartbeats lists the account’s heartbeats, optionally filtered to one service.

    Example Usage

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

const backup = zenduty.getHeartbeats({
    serviceId: backupZendutyServices.id,
});
export const expiredHeartbeats = backup.then(backup => .filter(h => h.status == "expired").map(h => (h.name)));

    import pulumi
import pulumi_zenduty as zenduty

backup = zenduty.get_heartbeats(service_id=backup_zenduty_services["id"])
pulumi.export("expiredHeartbeats", [h.name for h in backup.heartbeats if h.status == "expired"])

    Example coming soon!

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

return await Deployment.RunAsync(() => 
{
    var backup = Zenduty.GetHeartbeats.Invoke(new()
    {
        ServiceId = backupZendutyServices.Id,
    });

    return new Dictionary<string, object?>
    {
        ["expiredHeartbeats"] = .Where(h => h.Status == "expired").Select(h => 
        {
            return h.Name;
        }).ToList(),
    };
});

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Using getHeartbeats

    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 getHeartbeats(args: GetHeartbeatsArgs, opts?: InvokeOptions): Promise<GetHeartbeatsResult>
function getHeartbeatsOutput(args: GetHeartbeatsOutputArgs, opts?: InvokeOutputOptions): Output<GetHeartbeatsResult>
    def get_heartbeats(id: Optional[str] = None,
                   service_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetHeartbeatsResult
def get_heartbeats_output(id: pulumi.Input[Optional[str]] = None,
                   service_id: pulumi.Input[Optional[str]] = None,
                   opts: Optional[InvokeOutputOptions] = None) -> Output[GetHeartbeatsResult]
    func GetHeartbeats(ctx *Context, args *GetHeartbeatsArgs, opts ...InvokeOption) (*GetHeartbeatsResult, error)
func GetHeartbeatsOutput(ctx *Context, args *GetHeartbeatsOutputArgs, opts ...InvokeOption) GetHeartbeatsResultOutput

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

    public static class GetHeartbeats 
{
    public static Task<GetHeartbeatsResult> InvokeAsync(GetHeartbeatsArgs args, InvokeOptions? opts = null)
    public static Output<GetHeartbeatsResult> Invoke(GetHeartbeatsInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetHeartbeatsResult> Invoke(GetHeartbeatsInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetHeartbeatsResult> getHeartbeats(GetHeartbeatsArgs args, InvokeOptions options)
public static Output<GetHeartbeatsResult> getHeartbeats(GetHeartbeatsArgs args, InvokeOptions options)
public static Output<GetHeartbeatsResult> getHeartbeats(GetHeartbeatsArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: zenduty:index/getHeartbeats:getHeartbeats
  arguments:
    # arguments dictionary
    data "zenduty_get_heartbeats" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    ServiceId string
    Only return heartbeats of this service.
    Id string
    ServiceId string
    Only return heartbeats of this service.
    id string
    service_id string
    Only return heartbeats of this service.
    id String
    serviceId String
    Only return heartbeats of this service.
    id string
    serviceId string
    Only return heartbeats of this service.
    id str
    service_id str
    Only return heartbeats of this service.
    id String
    serviceId String
    Only return heartbeats of this service.

    getHeartbeats Result

    The following output properties are available:

    Heartbeats List<GetHeartbeatsHeartbeat>
    The list of heartbeats, each with:
    Id string
    ServiceId string
    , service_name, team_id, team_name
    Heartbeats []GetHeartbeatsHeartbeat
    The list of heartbeats, each with:
    Id string
    ServiceId string
    , service_name, team_id, team_name
    heartbeats list(object)
    The list of heartbeats, each with:
    id string
    service_id string
    , service_name, team_id, team_name
    heartbeats List<GetHeartbeatsHeartbeat>
    The list of heartbeats, each with:
    id String
    serviceId String
    , service_name, team_id, team_name
    heartbeats GetHeartbeatsHeartbeat[]
    The list of heartbeats, each with:
    id string
    serviceId string
    , service_name, team_id, team_name
    heartbeats Sequence[GetHeartbeatsHeartbeat]
    The list of heartbeats, each with:
    id str
    service_id str
    , service_name, team_id, team_name
    heartbeats List<Property Map>
    The list of heartbeats, each with:
    id String
    serviceId String
    , service_name, team_id, team_name

    Supporting Types

    GetHeartbeatsHeartbeat

    AlertMessage string
    , alert_urgency (0 low, 1 high, -1 when unset), ping_type, email_subject_contains
    AlertUrgency double
    Description string
    EmailSubjectContains string
    ExpiresAt string
    IntervalSeconds double
    , is_enabled, status (disabled, pending, healthy, expired)
    IsEnabled bool
    LastPingAt string
    Name string
    PingEmail string
    PingType double
    PingUrl string
    , ping_email, last_ping_at, expires_at
    ServiceId string
    Only return heartbeats of this service.
    ServiceName string
    Status string
    TeamId string
    TeamName string
    UniqueId string
    , name, description
    AlertMessage string
    , alert_urgency (0 low, 1 high, -1 when unset), ping_type, email_subject_contains
    AlertUrgency float64
    Description string
    EmailSubjectContains string
    ExpiresAt string
    IntervalSeconds float64
    , is_enabled, status (disabled, pending, healthy, expired)
    IsEnabled bool
    LastPingAt string
    Name string
    PingEmail string
    PingType float64
    PingUrl string
    , ping_email, last_ping_at, expires_at
    ServiceId string
    Only return heartbeats of this service.
    ServiceName string
    Status string
    TeamId string
    TeamName string
    UniqueId string
    , name, description
    alert_message string
    , alert_urgency (0 low, 1 high, -1 when unset), ping_type, email_subject_contains
    alert_urgency number
    description string
    email_subject_contains string
    expires_at string
    interval_seconds number
    , is_enabled, status (disabled, pending, healthy, expired)
    is_enabled bool
    last_ping_at string
    name string
    ping_email string
    ping_type number
    ping_url string
    , ping_email, last_ping_at, expires_at
    service_id string
    Only return heartbeats of this service.
    service_name string
    status string
    team_id string
    team_name string
    unique_id string
    , name, description
    alertMessage String
    , alert_urgency (0 low, 1 high, -1 when unset), ping_type, email_subject_contains
    alertUrgency Double
    description String
    emailSubjectContains String
    expiresAt String
    intervalSeconds Double
    , is_enabled, status (disabled, pending, healthy, expired)
    isEnabled Boolean
    lastPingAt String
    name String
    pingEmail String
    pingType Double
    pingUrl String
    , ping_email, last_ping_at, expires_at
    serviceId String
    Only return heartbeats of this service.
    serviceName String
    status String
    teamId String
    teamName String
    uniqueId String
    , name, description
    alertMessage string
    , alert_urgency (0 low, 1 high, -1 when unset), ping_type, email_subject_contains
    alertUrgency number
    description string
    emailSubjectContains string
    expiresAt string
    intervalSeconds number
    , is_enabled, status (disabled, pending, healthy, expired)
    isEnabled boolean
    lastPingAt string
    name string
    pingEmail string
    pingType number
    pingUrl string
    , ping_email, last_ping_at, expires_at
    serviceId string
    Only return heartbeats of this service.
    serviceName string
    status string
    teamId string
    teamName string
    uniqueId string
    , name, description
    alert_message str
    , alert_urgency (0 low, 1 high, -1 when unset), ping_type, email_subject_contains
    alert_urgency float
    description str
    email_subject_contains str
    expires_at str
    interval_seconds float
    , is_enabled, status (disabled, pending, healthy, expired)
    is_enabled bool
    last_ping_at str
    name str
    ping_email str
    ping_type float
    ping_url str
    , ping_email, last_ping_at, expires_at
    service_id str
    Only return heartbeats of this service.
    service_name str
    status str
    team_id str
    team_name str
    unique_id str
    , name, description
    alertMessage String
    , alert_urgency (0 low, 1 high, -1 when unset), ping_type, email_subject_contains
    alertUrgency Number
    description String
    emailSubjectContains String
    expiresAt String
    intervalSeconds Number
    , is_enabled, status (disabled, pending, healthy, expired)
    isEnabled Boolean
    lastPingAt String
    name String
    pingEmail String
    pingType Number
    pingUrl String
    , ping_email, last_ping_at, expires_at
    serviceId String
    Only return heartbeats of this service.
    serviceName String
    status String
    teamId String
    teamName String
    uniqueId String
    , name, description

    Package Details

    Repository
    zenduty zenduty/terraform-provider-zenduty
    License
    Notes
    This Pulumi package is based on the zenduty Terraform Provider.
    zenduty
    Viewing docs for zenduty 2.2.0
    published on Friday, Oct 30, 2026 by zenduty
    Schema (JSON)
    zenduty/terraform-provider-zenduty

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial