Create flag | SchematicHQ

import { SchematicClient } from "@schematichq/schematic-typescript-node";
async function main() {
    const client = new SchematicClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.features.createFlag({
        description: "string",
        flagType: "boolean",
        key: "string",
        name: "string",
    });
}
main();

{
  "data": {
    "created_at": "2024-01-15T09:30:00Z",
    "description": "string",
    "flag_type": "boolean",
    "id": "string",
    "key": "string",
    "name": "string",
    "rules": [
      {
        "condition_groups": [
          {
            "conditions": [
              {
                "condition_type": "base_plan",
                "created_at": "2024-01-15T09:30:00Z",
                "environment_id": "string",
                "id": "string",
                "operator": "eq",
                "resource_ids": [
                  "string"
                ],
                "resources": [
                  {
                    "id": "string",
                    "name": "string",
                    "description": "string",
                    "image_url": "string"
                  }
                ],
                "rule_id": "string",
                "trait_value": "string",
                "updated_at": "2024-01-15T09:30:00Z",
                "comparison_trait": {
                  "created_at": "2024-01-15T09:30:00Z",
                  "display_name": "string",
                  "entity_type": "company",
                  "hierarchy": [
                    "string"
                  ],
                  "id": "string",
                  "trait_type": "boolean",
                  "updated_at": "2024-01-15T09:30:00Z"
                },
                "comparison_trait_id": "string",
                "condition_group_id": "string",
                "event_subtype": "string",
                "flag_id": "string",
                "metric_period": "all_time",
                "metric_period_month_reset": "billing_cycle",
                "metric_value": 1,
                "plan_versions": [
                  {
                    "id": "string",
                    "name": "string",
                    "status": "published",
                    "version": 1
                  }
                ],
                "trait": {
                  "created_at": "2024-01-15T09:30:00Z",
                  "display_name": "string",
                  "entity_type": "company",
                  "hierarchy": [
                    "string"
                  ],
                  "id": "string",
                  "trait_type": "boolean",
                  "updated_at": "2024-01-15T09:30:00Z"
                },
                "trait_entity_type": "company",
                "trait_id": "string"
              }
            ],
            "created_at": "2024-01-15T09:30:00Z",
            "environment_id": "string",
            "id": "string",
            "rule_id": "string",
            "updated_at": "2024-01-15T09:30:00Z",
            "flag_id": "string"
          }
        ],
        "conditions": [
          {
            "condition_type": "base_plan",
            "created_at": "2024-01-15T09:30:00Z",
            "environment_id": "string",
            "id": "string",
            "operator": "eq",
            "resource_ids": [
              "string"
            ],
            "resources": [
              {
                "id": "string",
                "name": "string",
                "description": "string",
                "image_url": "string"
              }
            ],
            "rule_id": "string",
            "trait_value": "string",
            "updated_at": "2024-01-15T09:30:00Z",
            "comparison_trait": {
              "created_at": "2024-01-15T09:30:00Z",
              "display_name": "string",
              "entity_type": "company",
              "hierarchy": [
                "string"
              ],
              "id": "string",
              "trait_type": "boolean",
              "updated_at": "2024-01-15T09:30:00Z"
            },
            "comparison_trait_id": "string",
            "condition_group_id": "string",
            "event_subtype": "string",
            "flag_id": "string",
            "metric_period": "all_time",
            "metric_period_month_reset": "billing_cycle",
            "metric_value": 1,
            "plan_versions": [
              {
                "id": "string",
                "name": "string",
                "status": "published",
                "version": 1
              }
            ],
            "trait": {
              "created_at": "2024-01-15T09:30:00Z",
              "display_name": "string",
              "entity_type": "company",
              "hierarchy": [
                "string"
              ],
              "id": "string",
              "trait_type": "boolean",
              "updated_at": "2024-01-15T09:30:00Z"
            },
            "trait_entity_type": "company",
            "trait_id": "string"
          }
        ],
        "created_at": "2024-01-15T09:30:00Z",
        "environment_id": "string",
        "id": "string",
        "name": "string",
        "priority": 1,
        "rule_type": "company_override",
        "updated_at": "2024-01-15T09:30:00Z",
        "value": true,
        "flag_id": "string"
      }
    ],
    "updated_at": "2024-01-15T09:30:00Z",
    "feature": {
      "created_at": "2024-01-15T09:30:00Z",
      "description": "string",
      "event_source": "inference",
      "feature_type": "boolean",
      "icon": "string",
      "id": "string",
      "name": "string",
      "updated_at": "2024-01-15T09:30:00Z",
      "event_subtype": "string",
      "license_id": "string",
      "lifecycle_phase": "add_on",
      "maintainer_account_member_id": "string",
      "plural_name": "string",
      "singular_name": "string",
      "trait_id": "string",
      "usage_limit_trait_id": "string"
    },
    "feature_id": "string",
    "last_checked_at": "2024-01-15T09:30:00Z",
    "maintainer": {
      "created_at": "2024-01-15T09:30:00Z",
      "id": "string",
      "permissions": {},
      "updated_at": "2024-01-15T09:30:00Z",
      "email": "string",
      "first_name": "string",
      "image_url": "string",
      "last_name": "string",
      "name": "string",
      "role": "admin"
    },
    "maintainer_account_member_id": "string",
    "default_value": true
  },
  "params": {}
}

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

descriptionstringRequired<=1024 characters

flag_typeenumRequired

Allowed values:

keystringRequired<=512 characters

namestringRequired<=512 characters

feature_idstring or nullOptional

maintainer_account_member_idstring or nullOptional

default_valueboolean or nullOptionalDeprecated

Deprecated. On create, the value a check returns in every environment until that environment has a default rule. Ignored on update: flags are account-wide and rules are per environment, so set an environment’s default through its default rule via the flag rules endpoint

Response

Created

dataobject

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error