Skip to main content
ZStack
Monitoring & Collection/Profiling

CaptureHeap

Capture a heap profile snapshot from the specified target.

POST/api/v1/profiling/heap/capture

Operation ID

CaptureHeap

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • target
    StringRequired

    Target service endpoint to capture heap profile from.

    Example: my-service:6060

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • sessionId
    String

    Unique identifier of the profiling session.

    Example: sess-abc123

  • profileType
    String

    Profile type: goroutine, heap, or cpu.

    Example: goroutine

  • target
    String

    Target service or host being profiled.

    Example: my-service:6060

  • createdAt
    String

    Timestamp when the session was created.

    Example: 2026-01-15T08:00:00Z

  • status
    String

    Session status indicating outcome of profiling.

    Example: completed

  • rawDataSizeBytes
    String

    Size in bytes of the raw profiling data.

    Example: 204800