Get a list of all projects.

GET 
/api/admin/projects

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

Request

Query Parameters

archived boolean

Responses

200

projectsSchema

application/json

Schema

Schema

version integerrequired
The schema version used to represent the project data.
Example: 1

projects

object[]

required

A list of projects in the Unleash instance

Array [

id stringrequired

The id of this project

Example: dx-squad

name stringrequired

The name of this project

Example: DX-Squad

description stringnullabledeprecated

Additional information about the project

Example: DX squad feature release

health number

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

Example: 50

featureCount number

The number of features this project has

Example: 10

staleFeatureCount numberdeprecated

The number of stale features this project has

Example: 10

potentiallyStaleFeatureCount numberdeprecated

The number of potentially stale features this project has

Example: 10

memberCount number

The number of members this project has

Example: 4

createdAt date-time

When this project was created.

Example: 2023-07-27T12:12:28Z

updatedAt date-timenullabledeprecated

When this project was last updated.

Example: 2023-07-28T12:12:28Z

lastUpdatedAt date-timenullable

When this project was last updated.

Example: 2023-07-28T12:12:28Z

archivedAt date-timenullable

When this project was archived.

Example: 2023-07-28T12:12:28Z

favorite boolean

true if the project was favorited, otherwise false.

Example: true

mode string

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

Possible values: [open, protected, private]

Example: open

defaultStickiness stringdeprecated

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

Example: userId

avgTimeToProduction numberdeprecated

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

Example: 10

lastReportedFlagUsage date-timenullable

Across all flags in your project this is the last time usage metrics where reported from connected applications.

Example: 2023-07-28T12:12:28Z

owners

object

The users and/or groups that have the "owner" role in this project. If no such users or groups exist, the list will contain the "system" owner instead.

oneOf

MOD1

Array [

anyOf

MOD1

ownerType stringrequired

Possible values: [user]

name stringrequired

Example: User Name

imageUrl stringnullable

Example: https://example.com/image.jpg

email stringnullable

Example: user@example.com

MOD2

ownerType stringrequired

Possible values: [group]

name stringrequired

Example: Group Name

]

MOD2

Array [

ownerType stringrequired

Possible values: [system]

]

]

Example (from schema)

{
  "version": 1,
  "projects": [
    {
      "id": "dx-squad",
      "name": "DX-Squad",
      "health": 50,
      "featureCount": 10,
      "memberCount": 4,
      "createdAt": "2023-07-27T12:12:28Z",
      "lastUpdatedAt": "2023-07-28T12:12:28Z",
      "archivedAt": "2023-07-28T12:12:28Z",
      "favorite": true,
      "mode": "open",
      "lastReportedFlagUsage": "2023-07-28T12:12:28Z",
      "owners": [
        null
      ]
    }
  ]
}

401

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
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
A description of what went wrong.
Example: 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.

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."
}

403

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
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: NoAccessError
message string
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

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."
}

Loading...