HERE Pipeline Management API v2

HERE Pipeline Management API v2 — 38 operation(s) across 27 path(s), OpenAPI 3.0.2 version 2.17.10, harvested verbatim from the HERE developer documentation. The Pipelines API enables programmatic access and control over data processing pipelines. Pipelines can be used to process and enrich data in the HERE Workspace at scale. The Workspace supports the following types of pipelines: Stream Pipeline: A continuously-running pipeline that processes unbounded data as it arrives. Batch Pipeline: An intermittently-running pipeline that processes bounded data when an input Data Catalog changes. Using this API, these pipelines can be managed from a Continuous Integration/Continuous Delivery platform. Base URL is not fixed: the spec directs clients to resolve it at runtime through the HERE API Lookup Service (https://api-lookup.data.api.platform.here.com/lookup/v1).

Operations 38

POST /v2/packages Upload a new Package. #
GET /v2/pipelines Get the list of Pipelines. #
POST /v2/pipelines Create a new Pipeline. #
GET /v2/pipelines/{pipelineId} Get a Pipeline. #
PUT /v2/pipelines/{pipelineId} Update a Pipeline. #
DELETE /v2/pipelines/{pipelineId} Delete a Pipeline. #
GET /v2/pipelines/{pipelineId}/hrn Get a Pipeline HRN. #
GET /v2/pipelines/{pipelineId}/snapshots List Snapshots of a Pipeline. #
GET /v2/pipelines/{pipelineId}/snapshots/{snapshotId} Get a Snapshot. #
GET /v2/pipelines/{pipelineId}/versions Get the list of PipelineVersions for a Pipeline. #
POST /v2/pipelines/{pipelineId}/versions Create a new PipelineVersion. #
GET /v2/pipelines/{pipelineId}/versions/{versionId} Get a PipelineVersion. #
DELETE /v2/pipelines/{pipelineId}/versions/{versionId} Delete a PipelineVersion. #
GET /v2/pipelines/{pipelineId}/versions/{versionId}/jobs List Jobs of a PipelineVersion. #
GET /v2/pipelines/{pipelineId}/versions/{versionId}/logging-configuration The logging configuration. #
PUT /v2/pipelines/{pipelineId}/versions/{versionId}/logging-configuration Update logging configuration for pipeline version. #
GET /v2/pipelines/{pipelineId}/versions/{versionId}/operations List Operations of a PipelineVersion. #
POST /v2/pipelines/{pipelineId}/versions/{versionId}/operations/activate Schedules a PipelineVersion. #
POST /v2/pipelines/{pipelineId}/versions/{versionId}/operations/cancel Cancel a PipelineVersion. #
POST /v2/pipelines/{pipelineId}/versions/{versionId}/operations/deactivate Deactivate a PipelineVersion. #
POST /v2/pipelines/{pipelineId}/versions/{versionId}/operations/pause Pause a running PipelineVersion. #
POST /v2/pipelines/{pipelineId}/versions/{versionId}/operations/resume Resume a paused PipelineVersion. #
POST /v2/pipelines/{pipelineId}/versions/{versionId}/operations/upgrade Upgrade a PipelineVersion. #
GET /v2/pipelines/{pipelineId}/versions/{versionId}/operations/{operationId} Get an Operation of a PipelineVersion. #
GET /v2/runtimeEnvironments Get runtime environments information. #
GET /v2/resourceProfiles Get available resource profiles. #
GET /v2/templates Get the list of PipelineTemplates. #
POST /v2/templates Create a new PipelineTemplate. #
GET /v2/templates/{templateId} Get a PipelineTemplate. #
DELETE /v2/templates/{templateId} Delete a PipelineTemplate. #
GET /v2/templates/{templateId}/hrn Get a PipelineTemplate HRN. #
GET /v2/pipelines/{pipelineId}/versions/{versionId}/scheduler-configuration The scheduler configuration. #
PUT /v2/pipelines/{pipelineId}/versions/{versionId}/scheduler-configuration Update scheduler configuration for PipelineVersion. #
GET /v2/egressRules List all egress rules in a realm. Any user authenticated with realm can access this endpoint. #
POST /v2/egressRules Create one or more egress rules atomically. If one or more rules supplied by the request already exist for the realm then request is declined. User should have OrgAdmin role within #
GET /v2/egressRules/{ruleId} Get a specific egress rule. Any user authenticated with realm can access this endpoint. #
DELETE /v2/egressRules/{ruleId} Delete a specific egress rule. User should have OrgAdmin role within the realm to be able to access this endpoint. #
GET /v2/egressRules/auditlog Retrieve a list of actions applied to EgressRules in a realm. User should have OrgAdmin role within the realm to be able to access this endpoint. #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/here-pipeline-management-v2"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

here-pipeline-management-v2-openapi.yml Raw ↑
{"openapi":"3.0.2","info":{"title":"Pipeline Management API v2","description":"The Pipelines API enables programmatic access and control over\n    data processing pipelines. Pipelines can be used to process and enrich data\n    in the HERE Workspace at scale. The Workspace supports the following types of\n    pipelines:\n\n      Stream Pipeline: A continuously-running pipeline that processes unbounded data as it arrives.\n      Batch Pipeline: An intermittently-running pipeline that processes bounded data when an input Data Catalog changes.\n\n    Using this API, these pipelines can be managed from a Continuous\n    Integration/Continuous Delivery platform.","version":"2.17.10"},"externalDocs":{"description":"The developer guide and changelogs are available here.","url":"https://www.here.com/docs/category/pipelines-api"},"servers":[{"url":"Use API Lookup for a base URL"}],"security":[{"Bearer":[]}],"tags":[{"name":"PipelineVersions"},{"name":"Packages"},{"name":"Pipelines"},{"name":"PipelineTemplates"},{"name":"EgressRules"}],"paths":{"/v2/packages":{"parameters":[{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"post":{"tags":["Packages"],"summary":"Upload a new Package.","description":"A Package is the jar file that contains the Pipeline code that you want to run. This endpoint receives and stores the Package file and returns the information about the stored Package. The filename of the jar file has a 200 character limit and the Package file size has 500 MB limit.","operationId":"createPackage","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["jarPackage"],"properties":{"jarPackage":{"type":"string","description":"Jar file to upload. The filename of the jar file has a 200 character limit and the Package file size has a 500 MB limit.","format":"binary"}}}}},"required":true},"responses":{"201":{"description":"Package is successfully uploaded and returned with an id.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelPackage"}}}},"400":{"description":"Package required fields or jar file not provided.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"413":{"description":"Package is too large. Package size limit is 500 MB.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"415":{"description":"Uploaded Package is not a valid Java Archive.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while storing the Package.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/v2/pipelines":{"parameters":[{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["Pipelines"],"summary":"Get the list of Pipelines.","description":"This endpoint returns a list of all Pipelines currently defined.","operationId":"listPipelines","responses":{"200":{"description":"List retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Pipeline"}}}}},"500":{"description":"Internal error while retrieving the list of Pipelines.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Pipelines"],"summary":"Create a new Pipeline.","description":"A Pipeline is the top-level entity introduced to group the work of implementing an actual data processing pipeline, in the form of one or more related PipelineVersions. This endpoint creates a Pipeline with no initial PipelineVersion and returns its metadata, that includes the id assigned to it.","operationId":"createPipeline","requestBody":{"description":"Pipeline to be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}},"required":true},"responses":{"201":{"description":"Pipeline successfully defined and returned with its id.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}},"400":{"description":"Required parameters are missing or invalid values were provided.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while defining the Pipeline.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"x-codegen-request-body-name":"body"}},"/v2/pipelines/{pipelineId}":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["Pipelines"],"summary":"Get a Pipeline.","description":"This endpoint returns the details about the Pipeline identified by the pipelineId path parameter.","operationId":"getPipeline","responses":{"200":{"description":"Pipeline retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}},"404":{"description":"Pipeline with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while retrieving the Pipeline.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Pipelines"],"summary":"Update a Pipeline.","description":"Updates the metadata about a pipeline identified by pipelineId. The PUT body contains the updated data. Note that the group field in Pipeline cannot be updated.","operationId":"updatePipeline","requestBody":{"description":"Pipeline details to be updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}},"required":true},"responses":{"200":{"description":"Pipeline updated successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}},"404":{"description":"Pipeline with provided ID not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while updating the pipeline.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"x-codegen-request-body-name":"body"},"delete":{"tags":["Pipelines"],"summary":"Delete a Pipeline.","description":"This endpoint deletes a Pipeline and its set of Pipeline Versions and associated content. The API will return an error if one or more of its Pipeline Versions are either 'running' or 'paused'.","operationId":"deletePipeline","responses":{"204":{"description":"Pipeline deleted successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{}},"404":{"description":"Pipeline with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"412":{"description":"The specified Pipeline can not be deleted because it has one or more dependent Pipeline Versions which have a state of 'running' or 'paused'.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while deleting the Pipeline.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/v2/pipelines/{pipelineId}/hrn":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["Pipelines"],"summary":"Get a Pipeline HRN.","description":"This endpoint returns the HRN of the Pipeline identified by the pipelineId path parameter.","operationId":"getPipelineHrn","responses":{"200":{"description":"Pipeline HRN retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrnResponse"}}}},"404":{"description":"Pipeline with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while retrieving the Pipeline HRN.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/v2/pipelines/{pipelineId}/snapshots":{"get":{"description":"This endpoint returns a list of the Snapshots associated with a Pipeline, sorted in descending order of time created, limited to the last 7 days and a max of 350 snapshots.","operationId":"listSnapshots","parameters":[{"description":"Identifier for a specific http request. If not present, one should be generated. This header and value should be returned in the http response.","in":"header","name":"X-Request-ID","schema":{"type":"string"}},{"description":"Identifier for all http requests made in service of an incoming http request. If not present, one should be generated. This header and value should be included in all outgoing http requests and should be returned in the response.","in":"header","name":"X-Correlation-ID","schema":{"type":"string"}},{"in":"header","name":"Authorization","schema":{"type":"string"}},{"in":"header","name":"Authorization-Claims","schema":{"type":"string"}},{"description":"System generated identifier (UUID or HRN) for the Pipeline.","examples":{"hrn":{"description":"hrn","summary":"pipelineId in HRN format","value":"hrn:here:pipeline::olp-here:00000000-0000-0000-0000-000000000000"},"uuid":{"description":"uuid","summary":"pipelineId in UUID format","value":"00000000-0000-0000-0000-000000000000"}},"in":"path","name":"pipelineId","required":true,"schema":{"type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Snapshot"},"type":"array"}}},"description":"List retrieved successfully."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}},"description":"Pipeline with provided id not found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}},"description":"Internal error while retrieving the list of Snapshots."}},"summary":"List Snapshots of a Pipeline.","tags":["Snapshots"]}},"/v2/pipelines/{pipelineId}/snapshots/{snapshotId}":{"get":{"description":"This endpoint returns the details about the Snapshot identified by the snapshotId path parameter.","operationId":"getSnapshot","parameters":[{"description":"Identifier for a specific http request. If not present, one should be generated. This header and value should be returned in the http response.","in":"header","name":"X-Request-ID","schema":{"type":"string"}},{"description":"Identifier for all http requests made in service of an incoming http request. If not present, one should be generated. This header and value should be included in all outgoing http requests and should be returned in the response.","in":"header","name":"X-Correlation-ID","schema":{"type":"string"}},{"in":"header","name":"Authorization","schema":{"type":"string"}},{"in":"header","name":"Authorization-Claims","schema":{"type":"string"}},{"description":"System generated identifier (UUID or HRN) for the Pipeline.","examples":{"hrn":{"description":"hrn","summary":"pipelineId in HRN format","value":"hrn:here:pipeline::olp-here:00000000-0000-0000-0000-000000000000"},"uuid":{"description":"uuid","summary":"pipelineId in UUID format","value":"00000000-0000-0000-0000-000000000000"}},"in":"path","name":"pipelineId","required":true,"schema":{"type":"string"}},{"description":"System generated identifier (UUID) for the Snapshot.","in":"path","name":"snapshotId","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snapshot"}}},"description":"Snapshot retrieved successfully."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}},"description":"Snapshot with provided id not found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}},"description":"Internal error while retrieving the Snapshot."}},"summary":"Get a Snapshot.","tags":["Snapshots"]}},"/v2/pipelines/{pipelineId}/versions":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["PipelineVersions"],"summary":"Get the list of PipelineVersions for a Pipeline.","description":"This endpoint returns a list of all PipelinesVersions currently defined for a given Pipeline.","operationId":"listPipelineVersions","parameters":[{"$ref":"#/components/parameters/PipelineVersionVerboseQueryParam"}],"responses":{"200":{"description":"List retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PipelineVersion"}}}}},"500":{"description":"Internal error while retrieving the list of PipelineVersions.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["PipelineVersions"],"summary":"Create a new PipelineVersion.","description":"Defines a new version for the given Pipeline. This includes all the information to run actual processing, including the Pipeline Template, actual input & output catalogs and configurations. This endpoint instantiates the PipelineVersion and returns its metadata, that includes the id assigned to it.","operationId":"createPipelineVersion","requestBody":{"description":"PipelineVersion to be created, with PipelineTemplate id and HRNs of input and output catalogs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineVersion"}}},"required":true},"responses":{"201":{"description":"PipelineVersion successfully created.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineVersion"}}}},"400":{"description":"Required parameters are missing or invalid values were provided.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Pipeline with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while instantiating the PipelineVersion.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"x-codegen-request-body-name":"body"}},"/v2/pipelines/{pipelineId}/versions/{versionId}":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/PipelineVersionIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["PipelineVersions"],"summary":"Get a PipelineVersion.","description":"This endpoint returns the details about the PipelineVersion identified by the versionId path parameter.","operationId":"getPipelineVersion","parameters":[{"$ref":"#/components/parameters/PipelineVersionVerboseQueryParam"}],"responses":{"200":{"description":"PipelineVersion retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineVersion"}}}},"404":{"description":"Pipeline or PipelineVersion with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while retrieving the PipelineVersion.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["PipelineVersions"],"summary":"Delete a PipelineVersion.","description":"This endpoint deletes a PipelineVersion. The API will throw an error if the Pipeline Version is in any state other than Ready, or if there are any pending operations.","operationId":"deletePipelineVersion","responses":{"204":{"description":"PipelineVersion deleted successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{}},"404":{"description":"Pipeline or PipelineVersion with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"412":{"description":"Can't delete a PipelineVersion that is not in READY state or has active operations.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while deleting the PipelineVersion.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/v2/pipelines/{pipelineId}/versions/{versionId}/jobs":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/PipelineVersionIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["PipelineVersions"],"summary":"List Jobs of a PipelineVersion.","description":"This endpoint returns a list of the Jobs a PipelineVersion ran or is currently running.","operationId":"listPipelineVersionJobs","responses":{"200":{"description":"List retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Job"}}}}},"404":{"description":"Pipeline or PipelineVersion with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"500":{"description":"Internal error while retrieving the list of Jobs.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}}},"/v2/pipelines/{pipelineId}/versions/{versionId}/logging-configuration":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/PipelineVersionIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["PipelineVersions"],"summary":"The logging configuration.","description":"This endpoint returns the current logging configuration that is set for the PipelineVersion.","operationId":"getLoggingConfiguration","responses":{"200":{"description":"Logging configuration retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoggingConfiguration"}}}},"404":{"description":"Logging configuration was not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while retrieving the logging configuration.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["PipelineVersions"],"summary":"Update logging configuration for pipeline version.","description":"Updates the logging configuration for the pipeline version. If there is a job currently running, the logging configuration will be applied to that job, and will be applied to the future jobs.","operationId":"updateLoggingConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoggingConfiguration"}}},"required":false},"responses":{"200":{"description":"Logging configuration updated successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoggingConfiguration"}}}},"307":{"description":"To update Logging configuration, please follow the redirect or use URL in the Location header.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"Location":{"description":"To proceed with the operation please follow the URL.","example":"https://xxx.yyy.zzz/operation","schema":{"type":"string"}}}},"400":{"description":"Cannot update logging configuration from current region.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Pipeline or PipelineVersion with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while updating the pipeline.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"x-codegen-request-body-name":"body"}},"/v2/pipelines/{pipelineId}/versions/{versionId}/operations":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/PipelineVersionIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["PipelineVersions"],"summary":"List Operations of a PipelineVersion.","description":"This endpoint returns a list of all Operations completed or pending on a PipelineVersion.","operationId":"listOperations","responses":{"200":{"description":"List retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Operation"}}}}},"404":{"description":"Combination of Pipeline and PipelineVersion ids not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"500":{"description":"Internal error while retrieving the list of Operations.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}}},"/v2/pipelines/{pipelineId}/versions/{versionId}/operations/activate":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/param

# --- truncated at 32 KB (113 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/here/refs/heads/main/openapi/here-pipeline-management-v2-openapi.yml