Start a Samply profile
Profile the pipeline using the Samply profiler for the next duration_secs seconds.
Authentication
| Scheme | Type | Details |
|---|---|---|
JSON web token (JWT) or API key | Bearer token | Authorization 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
| Name | Type | Required | Description |
|---|---|---|---|
pipeline_name | string | Yes | Unique pipeline name |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
ordinal | integer | No | In a multihost pipeline, the ordinal of the pipeline to sample. |
duration_secs | integer (int64) | No | The number of seconds to sample for the profile. |
Response
Started profiling the pipeline with the Samply tool
curl -X POST '/v0/pipelines/{pipeline_name}/samply_profile?ordinal=%3Cordinal%3E&duration_secs=%3Cduration_secs%3E' \
-H 'Authorization: Bearer YOUR_TOKEN'Pipeline with that name does not exist
{
"message": "Unknown pipeline name 'non-existent-pipeline'",
"error_code": "UnknownPipelineName",
"details": {
"pipeline_name": "non-existent-pipeline"
}
}