Retrieve info about pipeline executions matching a filter

GET https://{controlplane_path}/api/1/rest/public/runtime/{env_org}

Overview

This API retrieves information about pipeline executions that match the specified filters.

Prerequisites

Read access to the requested assets

Request

GET https://{controlplane_path}/api/1/rest/public/runtime/{env_org}?{query_parameters}

Path parameters


Key	Description
`controlplane_path`	Required. The path to the SnapLogic control plane: `elastic.snaplogic.com` For the UAT or EMEA control plane, substitute the name for `elastic`. For example: `uat.elastic.snaplogic.com` `emea.snaplogic.com`
`env_org`	Required. The name of the SnapLogic environment/Org. For example, `My-Dev-Env`

Query parameters

Attention:

You can use the state and last_hours parameters to retrieve a list of running pipelines for a timespan. However, the response might not include all pipelines that ran during that time because the missing runtimes started or completed outside of the specified timespan.
If a timespan is not set, this API returns information about pipeline executions within the last hour.


Key	Type	Description
`plex_label`	string	Returns information about pipeline executions for the specified Snaplex.
`cc_label`	string	Returns information about pipeline executions for the specified CC label (JCC node’s hostname).
`pipe_name`	string	Returns information about the specified pipeline execution.
`user_id`	string	Returns information about pipeline executions triggered by the specified user.
`state`	string	Returns information about pipeline executions in the specified state. Valid values: `Queued` – Pipeline is queued for processing; all pipelines start in this state. `NoUpdate` – Intermediate state at startup. `Prepared` – Pipeline has been prepared. `Started` – Pipeline has started running. `Completed` – Pipeline has completed successfully. `Failing` – Pipeline encountered an error and is waiting for Snaps to complete execution before moving to the Failed state. `Failed` – Pipeline failed. `Stopped` – Pipeline was stopped either by the user or by the system, as indicated by the "stopper" key. `Stopping` – Pipeline is stopping. `Suspending` – Resumable Pipeline encountered an error and is storing its state. `Suspended` – Resumable Pipeline encountered an error and is suspended. `Resuming` – Resumable Pipeline is loading its state and will resume execution where it left off. Default: `Completed`
`invoker`	string	Returns information about pipeline executions that were invoked in the specified way. Valid values: `triggered` – Triggered pipeline executions `scheduled` – Scheduled pipeline executions `always_on` – Ultra Task executions `manual` – User-triggered pipeline executions `nested` - Nested pipeline executions If no filter is applied the status is displayed as `any`.
`project_path`	string	Returns information about pipeline executions for the specified project. Allowed formats: `/{env_org}/projects/{project_name}` `/{env_org}/shared`
`last_hours`	integer	Returns information about pipeline executions within the specified number of hours, counting backward from the current time. Valid values: 1 through 1080 hours (45 days) Default: 1
`start`	integer	Returns information about pipeline executions since the specified time. Provide time as Unix time in milliseconds.
`end`	integer	Returns information about pipeline executions before the specified time. Provide time as Unix time in milliseconds.
`limit`	integer	Returns no more than the specified number of results. You can use `limit` and `offset` for pagination. Valid values: 1 through 1,000 Default: 10
`offset`	integer	Returns a subset of the results starting at this 0-based index. You can use `limit` and `offset` for pagination. Default: 0

Request header

In the request header, specify Basic for authorization, add your credentials (Login and password of your SnapLogic user or service account), and specify application/json for content type. For more details on accounts refer to Manage accounts.


Authorization: Basic {base64_encoded <email>:<password>}
Content-Type: application/json

Example of Basic authentication using Postman

When using JWT authentication, the API requests includes specific headers. In the request header, specify Bearer Token for authorization, add the token, and specify application/json for content type. These headers are automatically added when you configure bearer token authentication in your API client. The authorization header contains the word Bearer followed by a space and your JWT token.


Authorization: Bearer Token {token}
Content-Type: application/json

Example of JWT authenthication using Postman

Request body

None.

Response

Note: The results include:

Only the pipeline executions that you have permissions to view. Environment/Org admins can view all pipeline executions.
Up to 500 of the most recent runs of a child pipeline within a single run of the parent pipeline.

 {
  "response_map": {
    "entries": [
      {
        "pipe_id": "...",
        "has_lints": true,
        "documents": ...,
        "user_id": "...",
        "ccid": "...",
        "child_has_lints": true,
        "runtime_path_id":  "...",
        "parent_ruuid": "...",
        "subpipes": { ... },
        "state_timestamp": "...",
        "error_documents": ...,
        "label": "...",
        "path_id": "...",
        "state": "...",
        "create_time": "...",
        "invoker": "...",
        "duration": ...,
        "cc_label": "...",
        "id": "...",
        "runtime_label": "...",
        "mode": "..."
      }
    ],
    "total": ...,
    "limit": ...,
    "offset": ...
  },
  "http_status_code": 200
}


Key	Type	Description
`entries`	array	An array of objects containing metadata about each pipeline execution.
`pipe_id`	string	The ID of the pipeline.
`has_lints`	Boolean	If pipeline finished with lints warning.
`documents`	integer
`user_id`	string	The user who ran the pipeline.
`ccid`	string	The ID of the JCC node where the pipeline ran.
`child_has_lints`	Boolean
`runtime_path_id`	string	The identifier of the Snaplex. Format: `{org}/rt/{snaplex-location}/{snaplex-environment}`
`parent_ruuid`	string	The Runtime ID of the parent pipeline that triggered this child pipeline.
`subpipes`	object
`state_timestamp`	string
`error_documents`	integer
`label`	string	The name of the pipeline.
`path_id`	string	Project path of the pipeline.
`state`	string	The status of the pipeline execution. Valid values: `Queued` – Pipeline is queued for processing; all pipelines start in this state. `NoUpdate` – Intermediate state at startup. `Prepared` – Pipeline has been prepared. `Started` – Pipeline has started running. `Completed` – Pipeline has completed successfully. `Failing` – Pipeline encountered an error and is waiting for Snaps to complete execution before moving to the Failed state. `Failed` – Pipeline failed. `Stopped` – Pipeline was stopped either by the user or by the system, as indicated by the "stopper" key. `Stopping` – Pipeline is stopping. `Suspending` – Resumable Pipeline encountered an error and is storing its state. `Suspended` – Resumable Pipeline encountered an error and is suspended. `Resuming` – Resumable Pipeline is loading its state and will resume execution where it left off.
`create_time`	string	The time when the pipeline execution instance was created. Format: UTC
`invoker`	string	The user who invoked the pipeline execution.
`duration`	integer	The length of time that the pipeline ran, expressed in seconds.
`cc_label`	string
`id`	string	The ID of the pipeline execution.
`runtime_label`	string	The name of the pipeline.
`mode`	string	The mode of the pipeline execution. Possible values: `standard`
`total`	integer	The total number of results available.
`limit`	integer	The number of results returned.
`offset`	integer	The index of the first result returned.

Examples

To retrieve the status of executed Tasks within the Environment/Org for the last hour,
```
 GET https://elastic.snaplogic.com/api/1/rest/public/runtime/myEnvOrg
```
To retrieve the status of executed Tasks within the Environment/Org for a specified time range,
```
 GET https://elastic.snaplogic.com/api/1/rest/public/runtime/myEnvOrg?start=&end=
```

To retrieve the status of executed Tasks for the last 4 hours,

 GET https://elastic.snaplogic.com/api/1/rest/public/runtime/myEnvOrg?last_hours=4