Update feature

Use when changing feature definition (e.g. name, type, or meter). Request body contains the fields to update.

PUT /features/{id}

Update feature

cURL

curl --request PUT \
  --url https://api.tirdad.ai/v1/features/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "alert_settings": {
    "alert_enabled": true,
    "critical": {
      "threshold": 123
    },
    "info": {
      "threshold": 123
    },
    "warning": {
      "threshold": 123
    }
  },
  "description": "<string>",
  "filters": [
    {
      "key": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "group_id": "<string>",
  "metadata": {},
  "name": "<string>",
  "reporting_unit": {
    "conversion_rate": 123,
    "unit_plural": "<string>",
    "unit_singular": "<string>"
  },
  "unit_plural": "<string>",
  "unit_singular": "<string>"
}
'

200

{
  "alert_settings": {
    "alert_enabled": true,
    "critical": {
      "threshold": 123
    },
    "info": {
      "threshold": 123
    },
    "warning": {
      "threshold": 123
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "description": "<string>",
  "environment_id": "<string>",
  "group": {
    "created_at": "2023-11-07T05:31:56Z",
    "entity_ids": [
      "<string>"
    ],
    "entity_type": "<string>",
    "id": "<string>",
    "lookup_key": "<string>",
    "metadata": {},
    "name": "<string>",
    "status": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "group_id": "<string>",
  "id": "<string>",
  "lookup_key": "<string>",
  "metadata": {},
  "meter": {
    "aggregation": {
      "expression": "<string>",
      "field": "<string>",
      "group_by": "<string>",
      "multiplier": "<string>"
    },
    "created_at": "2024-03-20T15:04:05Z",
    "event_name": "api_request",
    "filters": [
      {
        "key": "<string>",
        "values": [
          "<string>"
        ]
      }
    ],
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "API Usage Meter",
    "status": "published",
    "tenant_id": "tenant123",
    "updated_at": "2024-03-20T15:04:05Z"
  },
  "meter_id": "<string>",
  "name": "<string>",
  "reporting_unit": {
    "conversion_rate": 123,
    "unit_plural": "<string>",
    "unit_singular": "<string>"
  },
  "tenant_id": "<string>",
  "unit_plural": "<string>",
  "unit_singular": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": "<string>"
}

Authorizations

x-api-key · string · header · required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

id · string · required

Feature ID

Body

application/json

Feature update data

alert_settings · object

Show child attributes

description · string

filters · object[]

Show child attributes

group_id · string

GroupID is the id of the group to assign the feature to. Pass empty string to clear.

metadata · object

Show child attributes

name · string

reporting_unit · object

Show child attributes

unit_plural · string

unit_singular · string

Response

200

application/json

OK

alert_settings · object

Show child attributes

created_at · string<date-time>

created_by · string

description · string

environment_id · string

group · object

Show child attributes

group_id · string

id · string

lookup_key · string

metadata · object

Show child attributes

meter · object

Show child attributes

meter_id · string

name · string

reporting_unit · object

Show child attributes

status · enum<string>

Available options: published, deleted, archived

tenant_id · string

type · enum<string>

Available options: metered, boolean, static

unit_plural · string

unit_singular · string

updated_at · string<date-time>

updated_by · string