---
# @generated by sylphx-gen 0.1.0 from contracts@fb95f0c42a0ec5d8e3cb694c0054b529c0b24b184112c65ef60c9044b4ce61f9. Do not edit.
title: "Create a profile"
description: "`secrets.profiles.create` (POST /v1/{parent}/profiles): Creates an empty profile; its first version is written by a write-back mount (`:open` with WRITE_BACK, then `:commit`)."
type: reference
product: platform
summary: "Creates an empty profile; its first version is written by a write-back mount (`:open` with WRITE_BACK, then `:commit`)."
updated: 2026-09-28
nav: false
---

Creates an empty profile; its first version is written by a write-back mount (`:open` with WRITE_BACK, then `:commit`).

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/profiles`
- **Scope** `secrets:write`
- **Effect** `write` — a successful call changes state.
- **Collection** [profiles](/docs/api/profiles)
- **Query** `profile_id`, `validate_only`

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `parent` | `string` | The environment to create in. Required. |
| `profile` | `Profile` | The profile to create; only spec is read. Required. |
| `profile_id` | `string` | The id of the new profile, `^[a-z]([a-z0-9_-]{0,61}[a-z0-9])?$`; the server assigns one when empty. |
| `validate_only` | `bool` | Validate and return the result without writing anything. |

### Profile

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/profiles/{profile}`. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `ProfileSpec` | 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. |

### ProfileSpec

| Field | Type | What it is |
| --- | --- | --- |
| `kind` | `ProfileKind` | What the profile holds. Required. One of `browser`, `computer`. |
| `grants` | `ProfileGrant[]` | Who may mount it and how. A principal with no grant cannot mount it, whatever its scopes. |
| `paths` | `string[]` | For a `computer` profile: the paths under the sandbox's home directory its archive holds, for example `.config/app`. |

### ProfileGrant

| Field | Type | What it is |
| --- | --- | --- |
| `principal` | `string` | The Access principal, as its keys carry it (for example a service account's id). Required. |
| `mode` | `ProfileMountMode` | The most it may mount: READ_ONLY, or WRITE_BACK (which includes READ_ONLY). Required. One of `read_only`, `write_back`. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/profiles/{profile}`. |
| `uid` | `string` | `pfl_<cell><ulid>`. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `ProfileSpec` | Desired state. Required. |
| `status` | `ProfileStatus` | Observed state. Output only. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `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. |
| `creator` | `string` | The principal that created the Resource. Output only. |

### ProfileSpec

| Field | Type | What it is |
| --- | --- | --- |
| `kind` | `ProfileKind` | What the profile holds. Required. One of `browser`, `computer`. |
| `grants` | `ProfileGrant[]` | Who may mount it and how. A principal with no grant cannot mount it, whatever its scopes. |
| `paths` | `string[]` | For a `computer` profile: the paths under the sandbox's home directory its archive holds, for example `.config/app`. |

### ProfileStatus

| Field | Type | What it is |
| --- | --- | --- |
| `observed_generation` | `int64` | The generation this status was computed from. Output only. |
| `conditions` | `Condition[]` | Ready. Output only. |
| `latest_version` | `string` | The newest version; empty until the first write-back. Output only. |
| `sites` | `ProfileSite[]` | The sites of the latest version and when each last changed. Output only. |

### ProfileGrant

| Field | Type | What it is |
| --- | --- | --- |
| `principal` | `string` | The Access principal, as its keys carry it (for example a service account's id). Required. |
| `mode` | `ProfileMountMode` | The most it may mount: READ_ONLY, or WRITE_BACK (which includes READ_ONLY). Required. One of `read_only`, `write_back`. |

### 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. |

### ProfileSite

| Field | Type | What it is |
| --- | --- | --- |
| `site` | `string` | The registrable domain (eTLD+1), for example `example.com`; for a `computer` profile, one declared path. Output only. |
| `update_time` | `timestamp` | When this site's record last changed. Output only. |

## 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/profiles" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spec":{"kind":"browser"}}'
```

**TypeScript**

```ts
const response = await sylphx.secrets.profiles.create({ parent: 'orgs/acme/projects/shop/envs/production', profile: { spec: { kind: 'browser' } } })
```

**Rust**

```rust
let mut req = sylphx::secrets::CreateProfileRequest::default();
req.parent = "orgs/acme/projects/shop/envs/production".to_string();
req.profile = Some(sylphx::secrets::Profile {
    spec: Some(sylphx::secrets::ProfileSpec {
        kind: sylphx::secrets::ProfileKind::Browser,
        ..Default::default()
    }),
    ..Default::default()
});
let response = sx.secrets().profiles().create(req).await?;
```

**CLI**

```bash
sylphx secrets profiles create --parent orgs/acme/projects/shop/envs/production --spec.kind browser
```

**MCP**

```json
{ "method_id": "secrets.profiles.create", "args": {"parent":"orgs/acme/projects/shop/envs/production","profile":{"spec":{"kind":"browser"}}} }
```