v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

Projects

Update project

Update a project. Updating a project uses a JSON patch representation of the desired changes. To learn more, read Updates.<br/><br/>To add an element to the project fields that are arrays, set the path to the name of the field and then append /<array index>. Use /0 to add to the beginning of the array. Use /- to add to the end of the array.

patch/api/v2/projects/{projectKey}

Path parameters

projectKeystring string required

The project key

Request body

opstring required

The type of operation to perform

pathstring required

A JSON Pointer string specifying the part of the document to operate on

valuestring

A JSON value used in "add", "replace", and "test" operations

Example request

[
  {
    "op": "replace",
    "path": "/exampleField",
    "value": "new example value"
  }
]

Response

Project response

_linksobject required

The location and content type of related resources

_idstring required

The ID of this project

keystring required

The key of this project

includeInSnippetByDefaultboolean required

Whether or not flags created in this project are made available to the client-side JavaScript SDK by default

namestring required

A human-friendly name for the project

tagsstring[] required

A list of tags for the project

defaultReleasePipelineKeystring

The key of the default release pipeline for this project

Example response

{
  "_links": {
    "environments": {
      "href": "/api/v2/projects/my-project/environments",
      "type": "application/json"
    },
    "self": {
      "href": "/api/v2/projects/my-project",
      "type": "application/json"
    }
  },
  "_id": "57be1db38b75bf0772d11383",
  "key": "project-key-123abc",
  "includeInSnippetByDefault": true,
  "name": "My Project",
  "_access": {
    "denied": [
      {
        "reason": {
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ],
          "effect": "allow"
        }
      }
    ],
    "allowed": [
      {
        "reason": {
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ],
          "effect": "allow"
        }
      }
    ]
  },
  "tags": [
    "ops"
  ],
  "environments": [
    {
      "_links": {
        "self": {
          "href": "/api/v2/projects/my-project/environments/my-environment",
          "type": "application/json"
        }
      },
      "_id": "57be1db38b75bf0772d11384",
      "key": "environment-key-123abc",
      "name": "My Environment",
      "apiKey": "sdk-xxx",
      "mobileKey": "mob-xxx",
      "color": "F5A623",
      "defaultTtl": 5,
      "secureMode": true,
      "_access": {
        "denied": [
          {
            "reason": {
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "actions": [
                "*"
              ],
              "effect": "allow"
            }
          }
        ],
        "allowed": [
          {
            "reason": {
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "actions": [
                "*"
              ],
              "effect": "allow"
            }
          }
        ]
      },
      "requireComments": true,
      "confirmChanges": true,
      "tags": [
        "ops"
      ],
      "approvalSettings": {
        "required": true,
        "minNumApprovals": 1,
        "canApplyDeclinedChanges": true,
        "autoApplyApprovedChanges": true,
        "serviceKind": "launchdarkly",
        "serviceConfig": {},
        "requiredApprovalTags": [
          "require-approval"
        ],
        "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"
      },
      "critical": true
    }
  ]
}