Update project enterprise settings

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

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

Request

Path Parameters

projectId stringrequired

application/json

Bodyrequired

updateProjectEnterpriseSettingsSchema

modestring
A mode of the project affecting what actions are possible in this project
Possible values: [open, protected, private]
Example: open
featureNaming object
Create a feature naming pattern
patternstringnullablerequired
A JavaScript regular expression pattern, without the start and end delimiters. Optional flags are not allowed.
Example: ^[A-Za-z]+\.[A-Za-z]+\.[A-Za-z0-9-]+$
examplestringnullable
An example of a feature name that matches the pattern. Must itself match the pattern supplied.
Example: dx.feature1.1-135
descriptionstringnullable
A description of the pattern in a human-readable format. Will be shown to users when they create a new feature flag.
Example: <project>.<featureName>.<ticket> The flag name should contain the project name, the feature name, and the ticket number, each separated by a dot.

Responses

200

This response has no body.

400

The request data does not match what we expect.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: ValidationError
messagestring
A description of what went wrong.
Example: The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].

Example (auto)

{
  "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 []."
}

401

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

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: AuthenticationRequired
messagestring
A description of what went wrong.
Example: 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.

Example (auto)

{
  "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."
}

403

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

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NoAccessError
messagestring
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (auto)

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

404

The requested resource was not found.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NotFoundError
messagestring
A description of what went wrong.
Example: Could not find the addon with ID "12345".

Example (auto)

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

415

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

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: ContentTypeerror
messagestring
A description of what went wrong.
Example: 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.

Example (auto)

{
  "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: Authorization

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PUT '<your-unleash-url>/api/admin/projects/:projectId/settings' \
-H 'Content-Type: application/json' \
-H 'Authorization: <Authorization>' \
-d '{
  "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."
  }
}'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

projectId — pathrequired

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."
  }
}

ResponseClear

Click the Send API Request button above and see the response here!