Get Lifecycle Profiles

Retrieves lifecycle profile list matching search criteria. This operation requires administrator role.

Required Permissions

Requires the ADMIN role or higher.

HTTP Request

GET /api/sonar/lifecycle-profiles

cURL Example

curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/lifecycle-profiles

Request Parameters

Key	Required	Type	Description	Notes
offset	N	32-bit integer	Number to skip	Default: `0`
limit	N	32-bit integer	Maximum count	Default: all if not specified
keywords	N	String	Search keywords	Searches in name and description fields

Success Response

HTTP status code 200 response

{
  "total_count": 3,
  "profiles": [
    {
      "guid": "76b8699d-91a1-4576-a908-7db753570a0a",
      "name": "default",
      "description": "Default lifecycle profile",
      "created": "2023-09-23 17:13:15+0900",
      "updated": "2023-09-23 17:13:15+0900"
    }
  ]
}

Response Fields

Field	Type	Description
total_count	32-bit integer	Total count of profiles matching search criteria
profiles	Array	Lifecycle profile list
profiles[].guid	String	Profile GUID
profiles[].name	String	Profile name
profiles[].description	String	Profile description
profiles[].created	String	Creation date/time (`yyyy-MM-dd HH:mm:ssZ` format)
profiles[].updated	String	Modification date/time (`yyyy-MM-dd HH:mm:ssZ` format)

Error Responses

offset, limit: non-integer values

HTTP status code 400 response

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' parameter should be int type"
}

offset, limit: negative values

HTTP status code 400 response

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' must be greater than or equal to 0."
}

permission: no lifecycle profile viewing permission

HTTP status code 500 response

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}