---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Create a config segment"
description: "`config.config_segments.create` (POST /v1/{parent}/config_segments): Creates a config segment."
type: reference
product: flags
summary: "Creates a config segment."
updated: 2026-09-28
nav: false
---

Creates a config segment.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/config_segments`
- **Scope** `config:write`
- **Effect** `write` — a successful call changes state.
- **Collection** [config_segments](/docs/api/config_segments)
- **Query** `config_segment_id`, `validate_only`
- **Operation** answers with an `Operation`; the result is `ConfigSegment`

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `parent` | `string` | The environment to create in. Required. |
| `config_segment` | `ConfigSegment` | The config segment to create; only spec is read. Required. |
| `config_segment_id` | `string` | The id of the new config segment, what IN_SEGMENT names. Required. |
| `validate_only` | `bool` | Validate and return the result without writing anything. |

### ConfigSegment

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/config_segments/{config_segment}`; the id is what IN_SEGMENT names. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `ConfigSegmentSpec` | Desired state. Required. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |

### ConfigSegmentSpec

| Field | Type | What it is |
| --- | --- | --- |
| `included` | `string[]` | Subjects always in the segment, by `user_id` or `anonymous_id`. |
| `excluded` | `string[]` | Subjects never in the segment, whatever else holds. |
| `conditions` | `TargetingCondition[]` | Conditions over the evaluation context; all must hold. |
| `description` | `string` | Who the segment is. |

### TargetingCondition

| Field | Type | What it is |
| --- | --- | --- |
| `attribute` | `string` | `user_id`, `anonymous_id`, or a path into the context's `attributes`, dot-separated (`plan`, `device.os`). Required, except with IN_SEGMENT and NOT_IN_SEGMENT. |
| `operator` | `ConditionOperator` | The comparison. Required. One of `equals`, `not_equals`, `greater_than`, `greater_or_equal`, `less_than`, `less_or_equal`, `contains`, `not_contains`, `starts_with`, `ends_with`, `in`, `not_in`, `matches`, `semver_greater_than`, `semver_greater_or_equal`, `semver_less_than`, `semver_less_or_equal`, `in_segment`, `not_in_segment`. |
| `value` | `value` | The value compared with; a list for IN and NOT_IN, a string for the string, regular expression and semantic version operators. Required. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `{parent-of-target}/operations/{operation}`. |
| `target` | `string` | The name of the Resource being changed. |
| `target_generation` | `int64` | The generation this Operation waits for. |
| `verb` | `OperationVerb` | What the Operation does. One of `create`, `update`, `delete`, `custom`. |
| `custom_verb` | `string` | The custom method verb when `verb` is CUSTOM, for example `revoke`. |
| `done` | `bool` | Whether the Operation has finished. |
| `create_time` | `timestamp` | When the Operation started. |
| `end_time` | `timestamp` | When the Operation finished. |
| `response` | `any` | The settled Resource (or Empty for a delete). One of the `result` group. |
| `error` | `ProblemDetails` | The failure, as the one error body. One of the `result` group. |
| `progress` | `OperationProgress` | Progress while not `done`. |

### ProblemDetails

| Field | Type | What it is |
| --- | --- | --- |
| `type` | `string` | `https://sylphx.com/docs/errors/<code in kebab-case>`. |
| `title` | `string` | A short customer-safe summary of the problem class. |
| `status` | `int32` | The HTTP status, fixed by `grpc_status`. |
| `detail` | `string` | A customer-safe explanation of this occurrence. Never contains SQL, stack traces, internal hostnames, or another tenant's data. |
| `instance` | `string` | The request id (`Sylphx-Request-Id`). |
| `code` | `string` | The stable UPPER_SNAKE code, one of ErrorCode without its prefix. |
| `grpc_status` | `string` | One of the 16 canonical gRPC status names, for example `ABORTED`. |
| `retryable` | `bool` | Whether the same request may be retried. |
| `effect` | `ErrorEffect` | What the failed call committed. One of `none`, `applied`, `unknown`. |
| `retry_after_ms` | `int64` | How long to wait before retrying, when the server knows. |
| `details` | `any[]` | Typed details such as PreconditionFailure or EntitlementDenial. |

### OperationProgress

| Field | Type | What it is |
| --- | --- | --- |
| `percent` | `int32` | Percent complete, when the controller can tell. |
| `message` | `string` | A customer-safe progress message. |
| `conditions` | `Condition[]` | The target's conditions when this progress was read. |

### Condition

| Field | Type | What it is |
| --- | --- | --- |
| `type` | `string` | The condition type, for example `Ready`. |
| `status` | `ConditionStatus` | Whether the condition holds. One of `true`, `false`, `unknown`. |
| `observed_generation` | `int64` | The generation this observation was made against. |
| `reason` | `string` | A machine-readable UpperCamelCase reason. |
| `message` | `string` | A customer-safe human-readable message. |
| `severity` | `Severity` | How severe a FALSE condition is. One of `info`, `warning`, `error`. |
| `transition_time` | `timestamp` | When `status` last changed. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`UNKNOWN_FIELD`](/docs/api/errors/UNKNOWN_FIELD) — The request has a field the schema does not know.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`RESOURCE_ALREADY_EXISTS`](/docs/api/errors/RESOURCE_ALREADY_EXISTS) — A Resource with this name exists.
- [`IDEMPOTENCY_KEY_REUSED`](/docs/api/errors/IDEMPOTENCY_KEY_REUSED) — An Idempotency-Key was reused with another body.
- [`IDEMPOTENCY_IN_PROGRESS`](/docs/api/errors/IDEMPOTENCY_IN_PROGRESS) — The first call with this Idempotency-Key is still running.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/config_segments" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spec":{}}'
```

**TypeScript**

```ts
const operation = await sylphx.config.configSegments.create({ configSegment: { spec: {} }, parent: 'orgs/acme/projects/shop/envs/production' })
```

**Rust**

```rust
let mut req = sylphx::config::CreateConfigSegmentRequest::default();
req.config_segment = Some(sylphx::config::ConfigSegment {
    spec: Some(Default::default()),
    ..Default::default()
});
req.parent = "orgs/acme/projects/shop/envs/production".to_string();
let operation = sx.config().config_segments().create(req).await?;
```

**CLI**

```bash
sylphx config config-segments create --parent orgs/acme/projects/shop/envs/production
```

**Terraform**

```hcl
resource "sylphx_config_config_segment" "config_segment" {
  config_segment_id = "config_segment"
  parent            = "orgs/acme/projects/shop/envs/production"
  spec              = {}
}
```

**MCP**

```json
{ "method_id": "config.config_segments.create", "args": {"config_segment":{"spec":{}},"parent":"orgs/acme/projects/shop/envs/production"} }
```