---
# @generated by sylphx-gen. Do not edit.
title: "sylphx hosting services"
description: "The sylphx hosting services commands of Sylphx Hosting: every verb, with its argument, its flags and a run line."
type: reference
product: hosting
summary: "Every sylphx hosting services command: its argument, its flags and a run line."
updated: 2026-09-28
nav: false
---

> **This method is not served on the public API.** `api.sylphx.com` does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

The `services` commands of Sylphx Hosting, as the CLI spells them: the same
calls as [the `services` API page](/docs/api/services), typed for the
shell. [Install, sign in and the grammar](/docs/cli) are on the CLI index.

**Not available yet.** Sylphx Hosting is declared in the registry but no backend serves it: every command answers `501` with the problem code `UNIMPLEMENTED`.

## get

Gets a service.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx hosting services get orgs/acme/projects/shop/envs/production/services/service
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service` · scope `hosting:read` · effect `read` · [Request, response and examples](/docs/api/services/get)

## list

Lists services in a environment.

**`PARENT`** — optional: the CLI fills it from the linked project or the
key's scope when it is left out.

**CLI**

```bash
sylphx hosting services list orgs/acme/projects/shop/envs/production
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services` · scope `hosting:read` · effect `read` · [Request, response and examples](/docs/api/services/list)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--page-size` | `int` | At most this many; default 50, clamped to 1000. |
| `--page-token` | `string` | `next_page_token` of the previous page. |
| `--filter` | `string` | AIP-160 filter over labels, filterable fields, and Ready. |
| `--order-by` | `string` | AIP-132 ordering over filterable fields. |

## create

Creates a service. The Operation is done when the controller settles it.

**`ID`** — The id segment of the new Resource's name; the server assigns one when omitted.

**CLI**

```bash
sylphx hosting services create --parent orgs/acme/projects/shop/envs/production
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services` · scope `hosting:write` · effect `write` · [Request, response and examples](/docs/api/services/create)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--parent` | `string` | The parent to create in; defaults to the linked project or the key's scope. |
| `--meta.labels` | `key=value` | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
| `--meta.annotations` | `key=value` | Caller-writable, unindexed annotations. Repeat the flag for each value. |
| `--meta.display-name` | `string` | Caller-writable human-readable name. |
| `--spec.source.source-link` | `string` | Build from this SourceLink's repository on every push to `branch`. |
| `--spec.source.image` | `string` | Run this Artifact, by digest: `registry.sylphx.net/<path>@sha256:<hex>`. |
| `--spec.source.branch` | `string` | The branch that ships to this Service; default the SourceLink's production branch. Ignored for `image`. |
| `--spec.source.build.root-directory` | `string` | The directory inside the repository to build; default the root. |
| `--spec.source.build.dockerfile` | `string` | A Dockerfile path relative to `root_directory`; unset lets the zero-config frontend detect the stack. |
| `--spec.source.build.build-class` | `string` | The Build class, `sylphx-<os>-<size>`; default `sylphx-linux-standard`. |
| `--spec.command` | `string` | Overrides the image's command. |
| `--spec.port` | `int` | The port the application listens on; the public edge stays 443. |
| `--spec.exposure` | `enum` | Who can reach the Service; default PUBLIC. One of `public`, `internal`. |
| `--spec.size` | `enum` | The size of each instance; default the plan's. One of `nano`, `micro`, `small`, `standard`, `large`, `xlarge`, `xxlarge`. |
| `--spec.scaling.min-instances` | `int` | Instances kept running with no traffic; 0 idles to zero and wakes on request. |
| `--spec.scaling.max-instances` | `int` | Instances at most; 0 means the plan's limit. |
| `--spec.health.protocol` | `enum` | How to probe. One of `http`, `tcp`. |
| `--spec.health.path` | `string` | The HTTP path to probe when `protocol` is HTTP. |
| `--spec.health.startup-timeout` | `duration` | How long a new instance may take to pass its first probe. |
| `--spec.env` | `key=value` | Plain environment variables. Secret values bind through `secret_env`, never here. Repeat the flag for each value. |
| `--spec.secret-env` | `key=value` | Environment variables bound to Sylphx Secrets: variable name to Secret name. The value never enters the spec. Repeat the flag for each value. |
| `--spec.regions` | `string` | Regions to run in; default the project's home region. Repeat the flag for each value. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |

## update

Updates a service.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx hosting services update orgs/acme/projects/shop/envs/production/services/service
```

`PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service` · scope `hosting:write` · effect `write` · [Request, response and examples](/docs/api/services/update)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--meta.labels` | `key=value` | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
| `--meta.annotations` | `key=value` | Caller-writable, unindexed annotations. Repeat the flag for each value. |
| `--meta.display-name` | `string` | Caller-writable human-readable name. |
| `--spec.source.source-link` | `string` | Build from this SourceLink's repository on every push to `branch`. |
| `--spec.source.image` | `string` | Run this Artifact, by digest: `registry.sylphx.net/<path>@sha256:<hex>`. |
| `--spec.source.branch` | `string` | The branch that ships to this Service; default the SourceLink's production branch. Ignored for `image`. |
| `--spec.source.build.root-directory` | `string` | The directory inside the repository to build; default the root. |
| `--spec.source.build.dockerfile` | `string` | A Dockerfile path relative to `root_directory`; unset lets the zero-config frontend detect the stack. |
| `--spec.source.build.build-class` | `string` | The Build class, `sylphx-<os>-<size>`; default `sylphx-linux-standard`. |
| `--spec.command` | `string` | Overrides the image's command. |
| `--spec.port` | `int` | The port the application listens on; the public edge stays 443. |
| `--spec.exposure` | `enum` | Who can reach the Service; default PUBLIC. One of `public`, `internal`. |
| `--spec.size` | `enum` | The size of each instance; default the plan's. One of `nano`, `micro`, `small`, `standard`, `large`, `xlarge`, `xxlarge`. |
| `--spec.scaling.min-instances` | `int` | Instances kept running with no traffic; 0 idles to zero and wakes on request. |
| `--spec.scaling.max-instances` | `int` | Instances at most; 0 means the plan's limit. |
| `--spec.health.protocol` | `enum` | How to probe. One of `http`, `tcp`. |
| `--spec.health.path` | `string` | The HTTP path to probe when `protocol` is HTTP. |
| `--spec.health.startup-timeout` | `duration` | How long a new instance may take to pass its first probe. |
| `--spec.env` | `key=value` | Plain environment variables. Secret values bind through `secret_env`, never here. Repeat the flag for each value. |
| `--spec.secret-env` | `key=value` | Environment variables bound to Sylphx Secrets: variable name to Secret name. The value never enters the spec. Repeat the flag for each value. |
| `--spec.regions` | `string` | Regions to run in; default the project's home region. Repeat the flag for each value. |
| `--allow-missing` | `bool` | Create the Resource when it does not exist (declarative upsert). |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |

## delete

Deletes a service.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx hosting services delete orgs/acme/projects/shop/envs/production/services/service --yes
```

`DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service` · scope `hosting:write` · effect `destructive` · [Request, response and examples](/docs/api/services/delete)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--etag` | `string` | Delete only if the current etag matches. |
| `--allow-missing` | `bool` | Succeed when the Resource does not exist. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--force` | `bool` | Also delete every child Resource; without it a parent with children fails with FAILED_PRECONDITION. |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |
| `--yes` | `bool` | Do not ask before this destructive call. |