List Pipelines

GET 
/pipelines

List the available pipelines.

Request

Query Parameters

limit integer

Default value: 10

Number of items to return in the response list.

filter string

Filter results that match values in the given key separated by a colon. These are not exact matches, so filtering on a value of pet:cat will return cat along with caterpillar pets. Filter parameters may be repeated if multiple filters are desired, but a given field can only be queried once because all filters will be logically ANDed.

sort string

Possible values: [asc, desc]

Default value: asc

Sort order, asc (default) for ascending and desc for descending alphabetical order by name.

starting_after string

The token (base64 string) next_page_token returned in the previous page of results. This is used to fetch the next page of results when the sort order is asc.

ending_before string

The token (base64 string) next_page_token returned in the previous page of results. This is used to fetch the next page of results when the sort order is desc.

Responses

200

OK

application/json

Schema

Schema

data objectrequired
pipelines object[]
Array [
date_created string
date_modified string
namespace string
name string
display_name string
product_id number
description string
api_config object
base_url string
headers object
auth_provider string
settings_schema object
The schema of the pipeline's order settings
billing_metric string
tags string[]
contacts string[]
documentation_link string
enabled boolean
orders_cancellable boolean
settings_config object
default_settings object
geometry_fields array
pipeline_links object
self string
post_order string
]
links objectrequired
request string
next_page string
request_timestamp stringrequired
response_timestamp stringrequired
request_duration numberrequired
next_page_token string

Example (from schema)

{
  "data": {
    "pipelines": [
      {
        "date_created": "2023-02-21T16:34:00Z",
        "date_modified": "2023-03-17T16:28:06Z",
        "namespace": "imagery",
        "name": "analysis-ready",
        "display_name": "analysis-ready",
        "product_id": 94,
        "description": "Pipeline for ordering Analysis-Ready Data imagery",
        "api_config": {
          "base_url": "https://api.maxar.com/ordering/v1/",
          "headers": {},
          "auth_provider": "mgp"
        },
        "settings_schema": {
          "$schema": "http://json-schema.org/draft-04/schema#",
          "description": "Schema to validate parameters of ARD order",
          "additionalProperties": false,
          "title": "ARD order parameters",
          "type": "object",
          "properties": {
            "ard_settings": {
              "type": "object",
              "properties": {
                "bundle_adjust": {
                  "type": "boolean"
                },
                "cloud_mask": {
                  "type": "boolean"
                },
                "pan_analytic": {
                  "type": "boolean"
                },
                "water_mask": {
                  "type": "boolean"
                },
                "data_mask": {
                  "type": "boolean"
                },
                "ms_analytic": {
                  "type": "boolean"
                },
                "ms_saturation_mask": {
                  "type": "boolean"
                },
                "healthy_vegetation_mask": {
                  "type": "boolean"
                },
                "terrain_shadow_mask": {
                  "type": "boolean"
                },
                "visual": {
                  "type": "boolean"
                },
                "hd": {
                  "type": "boolean"
                },
                "pan_flare_mask": {
                  "type": "boolean"
                }
              }
            },
            "acquisitions": {
              "type": "array",
              "items": {
                "oneOf": [
                  {
                    "additionalProperties": false,
                    "type": "object",
                    "properties": {
                      "cell_ids": {
                        "type": "array"
                      },
                      "id": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "id"
                    ]
                  },
                  {
                    "type": "string"
                  }
                ]
              }
            },
            "intersects": {
              "type": [
                "string",
                "object"
              ]
            },
            "bbox": {
              "type": "array",
              "items": {
                "minItems": 4,
                "type": "number",
                "maxItems": 4
              }
            }
          },
          "required": [
            "acquisitions"
          ],
          "$id": "https://example.com/example.schema.json"
        },
        "billing_metric": "sqkm",
        "tags": [
          "string"
        ],
        "contacts": [
          "string"
        ],
        "documentation_link": "string",
        "enabled": true,
        "orders_cancellable": false,
        "settings_config": {
          "default_settings": {},
          "geometry_fields": [
            null
          ]
        },
        "pipeline_links": {
          "self": "https://api.maxar.com/ordering/v1/pipelines-integration/imagery/analysis-ready",
          "post_order": "https://api.maxar.com/ordering/v1/pipelines-integration/imagery/analysis-ready/order"
        }
      }
    ]
  },
  "links": {
    "request": true,
    "next_page": "https://api.maxar.com/ordering/v1/pipelines/imagery/analysis-ready/orderorders?starting_after=eyJQSyI6ICJVc2VyLTAyMWMyYjJkLTQwZWUtNGZhNy1iZDEwLTEzYjRhMDQ4OTk2OCIsICJTSyD"
  },
  "request_timestamp": "2022-12-01T23:19:02Z",
  "response_timestamp": "2022-12-01T23:19:06Z",
  "request_duration": 4,
  "next_page_token": "eyJQSyI6ICJVc2VyLTAyMWMyYjJkLTQwZWUtNGZhNy1iZDEwLTEzYjRhMDQ4OTk2OCIsICJTSyD"
}

Loading...