Skip to Content
API ReferenceMetrics DebuggingStart a Samply profile

Start a Samply profile

POST/v0/pipelines/{pipeline_name}/samply_profile
Authentication
Parameters

Profile the pipeline using the Samply profiler for the next duration_secs seconds.

Authentication

SchemeTypeDetails
JSON web token (JWT) or API keyBearer tokenAuthorization header · Use a JWT token obtained via an OAuth2/OIDC login workflow or an API key obtained via the `/v0/api-keys` endpoint.

Parameters

Path parameters

NameTypeRequiredDescription
pipeline_namestringYesUnique pipeline name

Query parameters

NameTypeRequiredDescription
ordinalintegerNoIn a multihost pipeline, the ordinal of the pipeline to sample.
duration_secsinteger (int64)NoThe number of seconds to sample for the profile.

Response

Started profiling the pipeline with the Samply tool
Request
curl -X POST '/v0/pipelines/{pipeline_name}/samply_profile?ordinal=%3Cordinal%3E&duration_secs=%3Cduration_secs%3E' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
Pipeline with that name does not exist
{ "message": "Unknown pipeline name 'non-existent-pipeline'", "error_code": "UnknownPipelineName", "details": { "pipeline_name": "non-existent-pipeline" } }