Update feature type lifetime
PUT /api/admin/feature-types/:id/lifetime
Updates the lifetime configuration for the specified feature toggle type. The expected lifetime is an integer representing the number of days before Unleash marks a feature toggle of that type as potentially stale. If set to null
or 0
, then feature toggles of that particular type will never be marked as potentially stale.
When a feature toggle type's expected lifetime is changed, this will also cause any feature toggles of this type to be reevaluated for potential staleness.
Request
Path Parameters
- id string required
- application/json
Body
required
updateFeatureTypeLifetimeSchema
- lifetimeDays integer nullable required
Possible values:
<= 2147483647
The new lifetime (in days) that you want to assign to the feature toggle type. If the value is
null
or0
, then the feature toggles of that type will never be marked as potentially stale. Otherwise, they will be considered potentially stale after the number of days indicated by this property.
- 200
- 400
- 401
- 403
- 404
- 409
- 415
featureTypeSchema
- application/json
- Schema
- Example (from schema)
Schema
- id string required
The identifier of this feature toggle type.
- name string required
The display name of this feature toggle type.
- description string required
A description of what this feature toggle type is intended to be used for.
- lifetimeDays integer nullable required
How many days it takes before a feature toggle of this typed is flagged as potentially stale by Unleash. If this value is
null
, Unleash will never mark it as potentially stale.
{
"id": "kill-switch",
"name": "Kill switch",
"description": "Kill switch feature toggles are used to quickly turn on or off critical functionality in your system.",
"lifetimeDays": 40
}
The request data does not match what we expect.
- application/json
- Schema
- Example (from 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.
{
"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
- Example (from 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.
{
"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
- Example (from 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.
{
"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
- Example (from 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.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NotFoundError",
"message": "Could not find the addon with ID \"12345\"."
}
The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.
- application/json
- Schema
- Example (from 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.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NameExistsError",
"message": "There is already a feature called \"my-awesome-feature\"."
}
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
- Example (from 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.
{
"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."
}