Skip to content
This repository has been archived by the owner on Sep 3, 2021. It is now read-only.

Latest commit

 

History

History
161 lines (98 loc) · 4.43 KB

ProjectsApi.md

File metadata and controls

161 lines (98 loc) · 4.43 KB
Raw

ProjectsApi

All URIs are relative to /api/v2

Method HTTP request Description
deleteProject DELETE /projects/{projectKey} Delete a project by key. Caution-- deleting a project will delete all associated environments and feature flags. You cannot delete the last project in an account.
getProject GET /projects/{projectKey} Fetch a single project by key.
getProjects GET /projects Returns a list of all projects in the account.
patchProject PATCH /projects/{projectKey} Modify a project by ID.
postProject POST /projects Create a new project with the given key and name.

deleteProject

Delete a project by key. Caution-- deleting a project will delete all associated environments and feature flags. You cannot delete the last project in an account.

Example

 deleteProject projectKey=value

Parameters

Name Type Description Notes
projectKey string The project key, used to tie the flags together under one project so they can be managed together.

Return type

(empty response body)

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getProject

Fetch a single project by key.

Example

 getProject projectKey=value

Parameters

Name Type Description Notes
projectKey string The project key, used to tie the flags together under one project so they can be managed together.

Return type

Project

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getProjects

Returns a list of all projects in the account.

Example

 getProjects

Parameters

This endpoint does not need any parameter.

Return type

Projects

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchProject

Modify a project by ID.

Example

 patchProject projectKey=value

Parameters

Name Type Description Notes
projectKey string The project key, used to tie the flags together under one project so they can be managed together.
patchDelta array[PatchOperation] Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'

Return type

Project

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postProject

Create a new project with the given key and name.

Example

 postProject

Parameters

Name Type Description Notes
projectBody ProjectBody Project keys must be unique within an account.

Return type

Project

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]