Get a list of all projects.

GET <your-unleash-url>/api/admin/projects

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

This endpoint returns an list of all the projects in the Unleash instance.

Request

Responses

• 200
• 401
• 403

---

projectsSchema

application/json

Schema

Schema

• version integer required

  The schema version used to represent the project data.

• projects object[]required

  A list of projects in the Unleash instance

  Array [

  id string required

  The id of this project

  name string required

  The name of this project

  description string nullable

  Additional information about the project

  health number

  An indicator of the project's health on a scale from 0 to 100

  featureCount number

  The number of features this project has

  staleFeatureCount number

  The number of stale features this project has

  potentiallyStaleFeatureCount number

  The number of potentially stale features this project has

  memberCount number

  The number of members this project has

  createdAt date-time

  When this project was created.

  updatedAt date-time nullable

  When this project was last updated.

  favorite boolean

  true if the project was favorited, otherwise false.

  mode string

  Possible values: [open, protected, private]

  The project's collaboration mode. Determines whether non-project members can submit change requests or not.

  defaultStickiness string

  A default stickiness for the project affecting the default stickiness value for variants and Gradual Rollout strategy

  avgTimeToProduction number

  The average time from when a feature was created to when it was enabled in the "production" environment during the current window

  ]

Example (from schema)

{
  "version": 1,
  "projects": [
    {
      "id": "dx-squad",
      "name": "DX-Squad",
      "description": "DX squad feature release",
      "health": 50,
      "featureCount": 10,
      "staleFeatureCount": 10,
      "potentiallyStaleFeatureCount": 10,
      "memberCount": 4,
      "createdAt": "2023-07-27T12:12:28Z",
      "updatedAt": "2023-07-28T12:12:28Z",
      "favorite": true,
      "mode": "open",
      "defaultStickiness": "userId",
      "avgTimeToProduction": 10
    }
  ]
}

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Request

Base URL

<your-unleash-url>

Security Scheme

apiKeybearerToken

apiKey

curl / cURL

curl -L -X GET '<your-unleash-url>/api/admin/projects' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

python / requests

curl -L -X GET '<your-unleash-url>/api/admin/projects' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

go / native

curl -L -X GET '<your-unleash-url>/api/admin/projects' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

nodejs / axios

curl -L -X GET '<your-unleash-url>/api/admin/projects' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

ruby / Net::HTTP

curl -L -X GET '<your-unleash-url>/api/admin/projects' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

csharp / RestSharp

curl -L -X GET '<your-unleash-url>/api/admin/projects' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

php / cURL

curl -L -X GET '<your-unleash-url>/api/admin/projects' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

java / OkHttp

curl -L -X GET '<your-unleash-url>/api/admin/projects' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

powershell / RestMethod

curl -L -X GET '<your-unleash-url>/api/admin/projects' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'