Update project enterprise settings

PUT <your-unleash-url>/api/admin/projects/:projectId/settings

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Update project enterprise settings with new values. Any fields not provided are ignored.

Request

Path Parameters

• projectId string required

application/json

Body

required

updateProjectEnterpriseSettingsSchema

• mode string

  Possible values: [open, protected, private]

  A mode of the project affecting what actions are possible in this project

• featureNaming object

  Create a feature naming pattern

  pattern string nullable required

  A JavaScript regular expression pattern, without the start and end delimiters. Optional flags are not allowed.

  example string nullable

  An example of a feature name that matches the pattern. Must itself match the pattern supplied.

  description string nullable

  A description of the pattern in a human-readable format. Will be shown to users when they create a new feature flag.

Responses

• 200
• 400
• 401
• 403
• 404
• 415

---

This response has no body.

The request data does not match what we expect.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ValidationError",
  "message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

The requested resource was not found.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ContentTypeerror",
  "message": "We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format."
}

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Request

Base URL

<your-unleash-url>

Security Scheme

apiKeybearerToken

apiKey

projectId — path required

Body required

{
  "mode": "open",
  "featureNaming": {
    "pattern": "^[A-Za-z]+.[A-Za-z]+.[A-Za-z0-9-]+$",
    "example": "dx.feature1.1-135",
    "description": "<project>.<featureName>.<ticket>\n\nThe flag name should contain the project name, the feature name, and the ticket number, each separated by a dot."
  }
}

curl / cURL

curl -L -X PUT '<your-unleash-url>/api/admin/projects/:projectId/settings' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "mode": "open",
  "featureNaming": {
    "pattern": "^[A-Za-z]+.[A-Za-z]+.[A-Za-z0-9-]+$",
    "example": "dx.feature1.1-135",
    "description": "<project>.<featureName>.<ticket>\n\nThe flag name should contain the project name, the feature name, and the ticket number, each separated by a dot."
  }
}'

python / requests

curl -L -X PUT '<your-unleash-url>/api/admin/projects/:projectId/settings' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "mode": "open",
  "featureNaming": {
    "pattern": "^[A-Za-z]+.[A-Za-z]+.[A-Za-z0-9-]+$",
    "example": "dx.feature1.1-135",
    "description": "<project>.<featureName>.<ticket>\n\nThe flag name should contain the project name, the feature name, and the ticket number, each separated by a dot."
  }
}'

go / native

curl -L -X PUT '<your-unleash-url>/api/admin/projects/:projectId/settings' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "mode": "open",
  "featureNaming": {
    "pattern": "^[A-Za-z]+.[A-Za-z]+.[A-Za-z0-9-]+$",
    "example": "dx.feature1.1-135",
    "description": "<project>.<featureName>.<ticket>\n\nThe flag name should contain the project name, the feature name, and the ticket number, each separated by a dot."
  }
}'

nodejs / native

curl -L -X PUT '<your-unleash-url>/api/admin/projects/:projectId/settings' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "mode": "open",
  "featureNaming": {
    "pattern": "^[A-Za-z]+.[A-Za-z]+.[A-Za-z0-9-]+$",
    "example": "dx.feature1.1-135",
    "description": "<project>.<featureName>.<ticket>\n\nThe flag name should contain the project name, the feature name, and the ticket number, each separated by a dot."
  }
}'

ruby / Net::HTTP

curl -L -X PUT '<your-unleash-url>/api/admin/projects/:projectId/settings' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "mode": "open",
  "featureNaming": {
    "pattern": "^[A-Za-z]+.[A-Za-z]+.[A-Za-z0-9-]+$",
    "example": "dx.feature1.1-135",
    "description": "<project>.<featureName>.<ticket>\n\nThe flag name should contain the project name, the feature name, and the ticket number, each separated by a dot."
  }
}'

csharp / httpclient

curl -L -X PUT '<your-unleash-url>/api/admin/projects/:projectId/settings' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "mode": "open",
  "featureNaming": {
    "pattern": "^[A-Za-z]+.[A-Za-z]+.[A-Za-z0-9-]+$",
    "example": "dx.feature1.1-135",
    "description": "<project>.<featureName>.<ticket>\n\nThe flag name should contain the project name, the feature name, and the ticket number, each separated by a dot."
  }
}'

php / cURL

curl -L -X PUT '<your-unleash-url>/api/admin/projects/:projectId/settings' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "mode": "open",
  "featureNaming": {
    "pattern": "^[A-Za-z]+.[A-Za-z]+.[A-Za-z0-9-]+$",
    "example": "dx.feature1.1-135",
    "description": "<project>.<featureName>.<ticket>\n\nThe flag name should contain the project name, the feature name, and the ticket number, each separated by a dot."
  }
}'

java / OkHttp

curl -L -X PUT '<your-unleash-url>/api/admin/projects/:projectId/settings' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "mode": "open",
  "featureNaming": {
    "pattern": "^[A-Za-z]+.[A-Za-z]+.[A-Za-z0-9-]+$",
    "example": "dx.feature1.1-135",
    "description": "<project>.<featureName>.<ticket>\n\nThe flag name should contain the project name, the feature name, and the ticket number, each separated by a dot."
  }
}'

powershell / RestMethod

curl -L -X PUT '<your-unleash-url>/api/admin/projects/:projectId/settings' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "mode": "open",
  "featureNaming": {
    "pattern": "^[A-Za-z]+.[A-Za-z]+.[A-Za-z0-9-]+$",
    "example": "dx.feature1.1-135",
    "description": "<project>.<featureName>.<ticket>\n\nThe flag name should contain the project name, the feature name, and the ticket number, each separated by a dot."
  }
}'