Change Requests

Retrieves pending change requests in configured environments

Changed on

Enterprise feature

This endpoint will retrieve the pending change requests in the configured environments for the project, for the current user performing the request.

get/api/admin/projects/{projectId}/change-requests/open

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/admin/projects/{projectId}/change-requests/open
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

projectIdstring required

Response

changeRequestsSchema

Example response

[
  {
    "id": 3,
    "title": "Increasing gradual rollout",
    "environment": "development",
    "minApprovals": 2,
    "project": "unleash-project",
    "features": [
      {
        "name": "my-feature",
        "conflict": "Feature has been archived",
        "changes": [
          {
            "id": 33,
            "action": "updateStrategy",
            "conflict": "Strategy has been deleted",
            "payload": [
              {
                "id": "9c40958a-daac-400e-98fb-3bb438567008",
                "sortOrder": 1
              }
            ],
            "createdAt": "2023-07-31T13:22:03+02:00"
          }
        ],
        "defaultChange": {
          "action": "addStrategy",
          "payload": {
            "name": "flexibleRollout",
            "title": "",
            "disabled": false,
            "segments": [],
            "parameters": {
              "groupId": "my-feature",
              "rollout": "100",
              "stickiness": "default"
            },
            "constraints": [
              {
                "values": [
                  "ux"
                ],
                "inverted": false,
                "operator": "STR_CONTAINS",
                "contextName": "userId",
                "caseInsensitive": false
              }
            ]
          }
        }
      }
    ],
    "segments": [
      {
        "id": 33,
        "action": "updateStrategy",
        "conflict": "Strategy has been deleted",
        "payload": [
          {
            "id": "9c40958a-daac-400e-98fb-3bb438567008",
            "sortOrder": 1
          }
        ],
        "createdAt": "2023-07-31T13:22:03+02:00",
        "name": "beta-users"
      }
    ],
    "approvals": [
      {
        "createdBy": {
          "id": 33,
          "username": "unleash-user"
        },
        "createdAt": "2022-12-12T12:13:24.218Z"
      }
    ],
    "rejections": [
      {
        "createdBy": {
          "id": 33,
          "username": "unleash-user"
        },
        "createdAt": "2022-12-12T12:13:24.218Z"
      }
    ],
    "comments": [
      {
        "id": 33,
        "text": "This is a comment",
        "createdBy": {
          "username": "unleash-user"
        },
        "createdAt": "2022-12-12T12:13:24.218Z"
      }
    ],
    "createdBy": {
      "username": "Hunter"
    },
    "createdAt": "2023-07-31T13:33:02Z"
  }
]

Changes

    • breaking

      added subschema #1 subschema #2 to the response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status