Introduction to the Pipelines REST APIs

JFrog REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

JFrog Pipelines provides a convenient and up-to-date self-descriptive API that can be used by various tools/frameworks to automate the creation and execution of pipelines.

Usage

Pipelines REST API endpoints can be invoked in any of the standard ways to invoke a RESTful API. This section describes how to use the Pipelines REST API using cURL as an example.

Using and Configuring cURL

You can download cURL here. Learn how to use and configure cURL here.

Authentication

Pipelines' REST API requires using an access token as a bearer token in the authorization header.

The example below demonstrates how to invoke the REST API to get the list of configured pipelines.

  • You have JFrog Pipelines running on your local system, on port 8082 (http://localhost:8082/pipelines/api)

  • You have created an Access Tokens

Using cURL with the REST API

$ curl -H 'Authorization: Bearer <token>' 'http://localhost:8082/pipelines/api/v1/pipelines' -X GET -H 'Content-Type: application/json'