Update project

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Update a project. Updating a project uses a JSON patch representation of the desired changes. To learn more, read Updates.

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. For example, "path": "/tags/0" adds a tag.

Note that tags are always deduplicated and returned in alphabetical order, regardless of the array index used in the patch path.

PATCH /api/v2/projects/{projectKey}

Update project

cURL

curl --request PATCH \
  --url https://app.launchdarkly.com/api/v2/projects/{projectKey} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "op": "add",
    "path": "/tags/0",
    "value": "another-tag"
  }
]
'

200

{
  "_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",
  "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,
      "defaultTrackEvents": false,
      "requireComments": true,
      "confirmChanges": true,
      "tags": [
        "ops"
      ],
      "critical": true,
      "_access": {
        "denied": [
          {
            "action": "<string>",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "<string>"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "<string>"
              ],
              "role_name": "<string>"
            }
          }
        ],
        "allowed": [
          {
            "action": "<string>",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "<string>"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "<string>"
              ],
              "role_name": "<string>"
            }
          }
        ]
      },
      "approvalSettings": {
        "required": true,
        "bypassApprovalsForPendingChanges": false,
        "minNumApprovals": 1,
        "canReviewOwnRequest": false,
        "canApplyDeclinedChanges": true,
        "serviceKind": "launchdarkly",
        "serviceConfig": {},
        "requiredApprovalTags": [
          "require-approval"
        ],
        "autoApplyApprovedChanges": true,
        "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"
      },
      "resourceApprovalSettings": {}
    }
  ],
  "defaultClientSideAvailability": {
    "usingMobileKey": true,
    "usingEnvironmentId": true
  },
  "_access": {
    "denied": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ],
    "allowed": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ]
  },
  "defaultReleasePipelineKey": "<string>"
}

Authorizations

Authorization · string · header · required

Path Parameters

projectKey · string<string> · required

The project key

Body

application/json

op · string · required

The type of operation to perform

Example:

"replace"

path · string · required

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

Example:

"/exampleField"

value · any

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

Example:

"new example value"

Response

200

application/json

Project response

_links · object · required

The location and content type of related resources

Show child attributes

Example:

{
  "environments": {
    "href": "/api/v2/projects/my-project/environments",
    "type": "application/json"
  },
  "self": {
    "href": "/api/v2/projects/my-project",
    "type": "application/json"
  }
}

_id · string · required

The ID of this project

Example:

"57be1db38b75bf0772d11383"

key · string · required

The key of this project

Example:

"project-key-123abc"

includeInSnippetByDefault · boolean · required

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

Example:

true

name · string · required

A human-friendly name for the project

Example:

"My Project"

tags · string[] · required

A list of tags for the project

Example:

["ops"]

environments · object[] · required

A list of environments for the project

Show child attributes

defaultClientSideAvailability · object

Describes which client-side SDKs can use new flags by default

Show child attributes

_access · object

Details on the allowed and denied actions for this project

Show child attributes

defaultReleasePipelineKey · string

The key of the default release pipeline for this project