Pacemaker Pipeline API

The Pipeline REST API provides different endpoints to interact with the pipeline.

The User must have access to the Pacemaker - Enterprise Integration Platform resource.

Get all Pipelines

Description

Endpoint Description

Endpoint	Description
GET `/V1/pacemaker/pipelines`	Receive a list of all pipelines. There are two optional params: `timePeriod`: A period of time in which the pipeline should have been created. Default: 24hours Possible Values: [0-9]* (minutes,hours,days,weeks,months,years) `pipelineName`: Filter for a pipeline

GET /V1/pacemaker/pipelines

Receive a list of all pipelines. There are two optional params:

timePeriod: A period of time in which the pipeline should have been created.
- Default: 24hours
- Possible Values: [0-9]* (minutes,hours,days,weeks,months,years)
pipelineName: Filter for a pipeline

Examples

GET <magento_url>/rest/V1/pacemaker/pipelines
GET <magento_url>/rest/V1/pacemaker/pipelines?timePeriod=2hours
GET <magento_url>/rest/V1/pacemaker/pipelines?timePeriod=4days&pipelineName=my_pipeline

Get specific Pipelines

Description

Endpoint Description

Endpoint	Description
GET `/V1/pacemaker/pipeline/<id>`	Receive a single pipeline by ID. There is one required param: `id`: The ID of the desired Pipeline

GET /V1/pacemaker/pipeline/<id>

Receive a single pipeline by ID. There is one required param:

id: The ID of the desired Pipeline

Examples

GET <magento_url>/rest/V1/pacemaker/pipeline/5

Get a specific Step

Description

Endpoint Description

Endpoint	Description
GET `/V1/pacemaker/step/details/<id>`	Receive info for the given step: `id`: The ID of the desired Step

GET /V1/pacemaker/step/details/<id>

Receive info for the given step:

id: The ID of the desired Step

Examples

GET <magento_url>/rest/V1/pacemaker/step/details/35

Initialize Pipeline

Description

Endpoint Description

Endpoint	Description
POST `V1/pacemaker/pipeline/init`	Create a registered pipeline by its name: Params: pipelineName Result: `id`: The ID of the created Pipeline

POST V1/pacemaker/pipeline/init

Create a registered pipeline by its name:

Params:
- pipelineName
Result:
- id: The ID of the created Pipeline

Examples

POST <magento_url>/rest/V1/pacemaker/pipeline/init?pipelineName=pacemaker_indexer

Cancel Pipelines

Description

Endpoint Description

Endpoint	Description
POST `V1/pacemaker/pipeline/cancel`	Cancel pipelines by names or by ids: Params: names //comma-separated technical pipeline names ids //comma-separated pipeline ids Result: array/list of canceled pipelines and steps

POST V1/pacemaker/pipeline/cancel

Cancel pipelines by names or by ids:

Params:
- names //comma-separated technical pipeline names
- ids //comma-separated pipeline ids
Result:
- array/list of canceled pipelines and steps

Examples

POST <magento_url>/rest/V1/pacemaker/pipeline/cancel?names=pacemaker_indexer,pixi_determination
POST <magento_url>/rest/V1/pacemaker/pipeline/cancel?ids=666,667

[
	{
		"id": "151",
		"name": "pacemaker_indexer"
	}
]

Pause Pipelines

Description

Endpoint Description

Endpoint	Description
POST `V1/pacemaker/pipeline/pause`	Pause pipelines by names or by ids: Params: names //comma-separated technical pipeline names ids //comma-separated pipeline ids all //flag to pause all running pipelines Result: array/list of paused pipelines and steps

POST V1/pacemaker/pipeline/pause

Pause pipelines by names or by ids:

Params:
- names //comma-separated technical pipeline names
- ids //comma-separated pipeline ids
- all //flag to pause all running pipelines
Result:
- array/list of paused pipelines and steps

Examples

POST <magento_url>/rest/V1/pacemaker/pipeline/pause?names=pacemaker_indexer,pixi_determination
POST <magento_url>/rest/V1/pacemaker/pipeline/pause?ids=666,667
POST <magento_url>/rest/V1/pacemaker/pipeline/pause?all=true

[
	{
		"id": "151",
		"name": "pacemaker_indexer"
	}
]

Resume Pipelines

Description

Endpoint Description

Endpoint	Description
POST `V1/pacemaker/pipeline/resume`	Resume paused pipelines by names or by ids: Params: names //comma-separated technical pipeline names ids //comma-separated pipeline ids all //flag to pause all paused pipelines Result: array/list of resumed pipelines and steps

POST V1/pacemaker/pipeline/resume

Resume paused pipelines by names or by ids:

Params:
- names //comma-separated technical pipeline names
- ids //comma-separated pipeline ids
- all //flag to pause all paused pipelines
Result:
- array/list of resumed pipelines and steps

Examples

POST <magento_url>/rest/V1/pacemaker/pipeline/resume?names=pacemaker_indexer,pixi_determination
POST <magento_url>/rest/V1/pacemaker/pipeline/resume?ids=666,667
POST <magento_url>/rest/V1/pacemaker/pipeline/resume?all=true

[
	{
		"id": "151",
		"name": "pacemaker_indexer"
	}
]

Process Step

Description

Endpoint Description

Endpoint	Description
POST `V1/pacemaker/pipeline/step/process`	Enqueue or requeue a step by its id: Params: stepId Result: true/false

POST V1/pacemaker/pipeline/step/process

Enqueue or requeue a step by its id:

Params:
- stepId
Result:
- true/false

Examples

POST <magento_url>/rest/V1/pacemaker/pipeline/step/process?stepId=880

Get running Steps count

Description

Endpoint Description

Endpoint	Description
GET `V1/pacemaker/pipeline/steps/activecount`	Get the count of running steps Result: int //count of running steps

GET V1/pacemaker/pipeline/steps/activecount

Get the count of running steps

Result:
- int //count of running steps

Examples

GET <magento_url>/rest/V1/pacemaker/pipeline/steps/activecount

Pipeline List

Description

Endpoint Description

Endpoint	Description
GET `V1/pacemaker/pipelines/list`	Get all pipelines registered in Pacemaker Result: List of all registered and configured pipelines

GET V1/pacemaker/pipelines/list

Get all pipelines registered in Pacemaker

Result:
- List of all registered and configured pipelines

Examples

GET <magento_url>/rest/V1/pacemaker/pipelines/list

[
	{
		"pipelineName": "clean_up_pipelines",
		"description": "Cleanup Pacemaker Pipelines",
		"numberOfSteps": 3
	},
    ...
]

Search for a pipeline

Description

Endpoint Description

GET V1/pacemaker/pipeline/search

Search pipeline and steps by a search string

Params:
- word //search string
- createdAt //optional filter
- startedAt //optional filter
- finishedAt //optional filter
Result:
- Result list of steps

Please note the time zones for the date filters.
The filter input is taken as UTC.
The output data is represented based on configuration.

Examples

GET <magento_url>/rest/V1/pacemaker/pipelines/search?word=index
GET <magento_url>/rest/V1/pacemaker/pipelines/search?word=index&startedAt=2025-07-15%2007%3A38%3A00
GET <magento_url>/rest/V1/pacemaker/pipelines/search?word=index&createdAt=2025-07-15%2007%3A38%3A00,2025-07-15%2009%3A03%3A00

[
	{
		"pipelineName": "pacemaker_indexer",
		"stepId": "880",
		"stepName": "pacemaker_force_reindex",
		"startedAt": "2025-07-25 14:12:19",
		"createdAt": "2025-07-15 09:37:10",
		"finishedAt": "2025-07-15 09:58:54"
	},
    ...
]

Check Step Conditions

Description

Endpoint Description

Endpoint	Description
GET `V1/pacemaker/step/conditions/<stepId>`	Checks the conditions of a step Params: stepId Result: List of conditions for the steps with status

GET V1/pacemaker/step/conditions/<stepId>

Checks the conditions of a step

Params:
- stepId
Result:
- List of conditions for the steps with status

Examples

GET <magento_url>/rest/V1/pacemaker/step/conditions/1050

[
	{
		"conditionType": "TechDivision\\PacemakerIndexer\\Virtual\\Condition\\NoConflictingIndexStepProcess",
		"isReady": false
	},
	{
		"conditionType": "TechDivision\\PacemakerImportBase\\Model\\Condition\\Step\\NoConflictingIndexingProcess",
		"isReady": true
	},
    ...
]

Pacemaker Pipeline API

Get all Pipelines

Get specific Pipelines

Get a specific Step

Initialize Pipeline

Cancel Pipelines

Pause Pipelines

Resume Pipelines

Process Step

Get running Steps count

Pipeline List

Search for a pipeline

Check Step Conditions

WIR HÄTTEN IHNEN DIESE MELDUNG AUCH GERNE ERSPART ...