1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
unleash.unleash/docs/api/admin/project.md
2021-03-12 19:08:18 +01:00

1.4 KiB

id title
projects /api/admin/projects

The projects feature is only available as part of Unleash Enterprise. In order to access the API programmatically you need to make sure you obtain a API token with admin permissions.

List projects in Unleash

GET https://unleash.host.com/api/admin/projects

Returns a list of projects in Unleash.

Example response:

{
  "version": 1,
  "projects": [
    {
      "id": "default",
      "name": "Default",
      "description": "Default project",
      "createdAt": "2020-12-03T09:47:20.170Z"
    },
    {
      "id": "MyNewProject",
      "name": "MyNewProject",
      "description": "A test project",
      "createdAt": "2020-12-03T09:47:20.170Z"
    },
    {
      "id": "test",
      "name": "Test Project",
      "description": "Collection of test toggles",
      "createdAt": "2020-12-03T09:47:20.170Z"
    }
  ]
}

Create a new project

POST https://unleash.host.com/api/admin/projects

Creates a new project.

Body

{
  "id": "someId",
  "name": "Test Project",
  "description": "Some description"
}

Update a projects field

PUT https://unleash.host.com/api/projects/:id

Updates a project with id=id.

Body

{
  "id": "someId",
  "name": "Test Project",
  "description": "Some description"
}

Delete a projects field

DELETE https://unleash.host.com/api/admin/projects/:id

Deletes the project with id=id.