This page is no longer maintained (Mar 29, 2023). For the most current information, go to https://docs.snaplogic.com/public-apis/get-runtime-org.html.

`GET /runtime/{org}`

Overview

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

Prerequisites

Read access to the requested assets

Request

Path Parameters

Key	Description

Key

Description

pod_path

Required. The path to your SnapLogic pod.

Example: elastic.snaplogic.com

org

Required. The name of the SnapLogic Org.

Query Parameters

If a timespan is not set, this API returns information about Task runs within the last hour.

Key	Type	Description

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: Started`
`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 pipeline executions` `manual – User-triggered pipeline executions` `Default: scheduled`
`project_path`	string	Returns information about pipeline executions for the specified project. Allowed formats: `/{org}/projects/{project_name}` `/{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

Specify Basic for authorization and application/json for content type.

Request Body

None.

Response

Response Header

Key	Description

Key

Description

X-SL-StatusCode

Status code indicating the results of the request.

Learn more: HTTP Status Code Registry

Response Body

The results include only the pipeline executions that you have permissions to view. Org Admins can view all pipeline executions.

{
  "response_map": {
    "entries": [ ... ],
    "total": ...,
    "limit": ...,
    "offset": ...
  },
  "http_status_code": 200
}

Key	Type	Description

Key	Type	Description
`entries`	array	An array of objects containing metadata about each pipeline execution.
`total`	integer	The total number of results available.
`limit`	integer	The number of results returned.
`offset`	integer	The index of the first result returned.

SnapLogic Documentation

Retrieve Info About Pipeline Executions Matching a Filter