Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Profiling
POSTProfilingSince 1.0SynchronousAuth Required

CaptureHeap

Capture a heap profile snapshot from the specified target.

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • targetStringRequired

    Target service endpoint to capture heap profile from.

    Example: my-service:6060

Responses

200 OK

On success, this API returns the following response structure.

  • sessionIdString

    Unique identifier of the profiling session.

    Example: sess-abc123

  • profileTypeString

    Profile type: goroutine, heap, or cpu.

    Example: goroutine

  • targetString

    Target service or host being profiled.

    Example: my-service:6060

  • createdAtString

    Timestamp when the session was created.

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

  • statusString

    Session status indicating outcome of profiling.

    Example: completed

  • rawDataSizeBytesString

    Size in bytes of the raw profiling data.

    Example: 204800

Endpoint

POST/api/v1/profiling/heap/capture

/api/v1/profiling/heap/capture

Operation ID

CaptureHeap

Permalink

Request Example

curl -X POST '{host}/api/v1/profiling/heap/capture' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"target":"my-service:6060"}'

Response Example

200
{
  "sessionId": "sess-abc123",
  "profileType": "goroutine",
  "target": "my-service:6060",
  "createdAt": "example",
  "status": "completed",
  "rawDataSizeBytes": 204800
}

Change History

This API has no change history records yet.

View all change history