Get Lifecycle

JFrog REST APIs

Content Type
REST API

Description: Returns the global lifecycle definition, or optionally, the lifecycle definition for a specific project.

Since: 7.125.4

Usage: GET https://{{artifactory-host}}/access/api/v2/lifecycle?project_key={{project-key}}

Query Parameter (optional):

Parameter

Type

Description

project_key

string

Filters the list for a specific project.

Response Body:

Property

Type

Description

release_stage

string

Name of the release stage (for example, PROD).

categories

array:array(section)

An ordered list of lifecycle categories and stages.

categories.category

string

The category name (code or promote).

categories.category.stages

array(stage)

An ordered list of stages within a particular category.

categories.category.stages.name

string

The stage name (for example, DEV or QA).

categories.category.stages.scope

string

The scope at which the stage exists (global or project).

Sample Request:

GET 'https://{host}.jfrog.io/access/api/v2/lifecycle'
Authorization: ••••••

Sample Response:

{
  "release_stage": "PROD",
  "categories": [
    {
      "category": "code",
      "stages": [
        { "name": "PR", "scope": "global" },
        { "name": "COMMIT", "scope": "global" }
      ]
    }, 
    {
      "category": "promote",
      "stages": [
        { "name": "qa-testing", "scope": "project" },
        { "name": "PROD", "scope": "global" }
      ]
    }
  ]
}

Status Codes:

Code

Description

202

Success

401

Bad Credentials

403

Permission Denied