Sign in

v1

latestOpenAPI 3.0.02026-07-13103151174.7 KB
[Deprecated] Features v1

Update a Feature

Update a Feature by ID or key

patch/v1/projects/{project}/features/{feature}

Path parameters

featurestring required

A Feature key or ID

projectstring required

A Project key or ID

Request body

keystring

Unique key by Project, can be used in the SDK / API to reference by 'key' rather than _id. Must only contain lower-case characters and _, - or ..

namestring

Name of the Feature

descriptionstring

Feature description.

configurationsobject
stalenessobject
type'release' | 'experiment' | 'permission' | 'ops'

Feature type.

tagsstring[]

Feature tags.

controlVariationstring

The key of the variation that is used as the control variation for Metrics

Example request

{
  "key": "new-dash",
  "name": "New Dashboard",
  "description": "New Dashboard",
  "configurations": {
    "development": {
      "status": "active",
      "targets": []
    },
    "production": {
      "status": "inactive",
      "targets": []
    }
  },
  "variations": [
    {
      "key": "variation-1",
      "name": "User's with dashboard access",
      "variables": {
        "show-new-dashboard": true,
        "string-var": "hello world",
        "bool-var": true,
        "num-var": 99,
        "json-var": {
          "foo": "bar"
        }
      }
    }
  ],
  "variables": [
    {
      "name": "Show New Dashboard",
      "description": "A boolean variable that will toggle the new dashboard feature",
      "key": "show-new-dashboard",
      "_feature": "61450f3daec96f5cf4a49947",
      "type": "Boolean",
      "tags": [
        "new",
        "dashboard"
      ]
    }
  ],
  "type": "release",
  "tags": [
    "new",
    "dashboard"
  ]
}

Response

_idstring required

A unique Feature ID

_projectstring required

The Project owning the Feature

source'api' | 'dashboard' | 'importer' | 'github.code_usages' | 'github.pr_insights' | 'gitlab.code_usages' | 'gitlab.pr_insights' | 'bitbucket.code_usages' | 'bitbucket.pr_insights' | 'terraform' | 'cli' | 'slack' | 'mcp' required

Source that created the Feature

status'active' | 'complete' | 'archived' required

Status of the Feature

type'release' | 'experiment' | 'permission' | 'ops'

The Feature type

namestring required

Name of the Feature

keystring required

Unique key by Project, can be used in the SDK / API to reference by 'key' rather than _id. Must only contain lower-case characters and _, - or ..

descriptionstring

Feature description.

_createdBystring

ID of the User who created the Feature

createdAtstring date-time required

The date the Feature was created

updatedAtstring date-time required

The date the Feature was last updated

prodTargetingUpdatedAtstring date-time

The date the Feature had an update that impacted production targeting

controlVariationstring required

The key of the variation that is used as the control variation for Metrics

staticVariationstring

The key of the variation that is set when the Feature's status is set to complete

tagsstring[]

Tags to organize Features on the dashboard

ldLinkstring

A link to the feature on LaunchDarkly if it has importedByLD type

readonlyboolean required

Controls whether the feature is editable for a given user

changeRequestsobject[]

Pending change requests for this Feature

stalenessFeatureStaleness