---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Get a service"
description: "`hosting.services.get` (GET /v1/{name}): Gets a service."
type: reference
product: hosting
summary: "Gets a service."
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.

Gets a service.

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

- **Path** `GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service`
- **Scope** `hosting:read`
- **Effect** `read` — nothing is written.
- **Collection** [services](/docs/api/services)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The name of the service to get. Required. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/services/{service}`. |
| `uid` | `string` | `svc_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `ServiceSpec` | Desired state. Required. |
| `status` | `ServiceStatus` | 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. |

### ServiceSpec

| Field | Type | What it is |
| --- | --- | --- |
| `source` | `ServiceSource` | What the Service runs. Required. |
| `command` | `string` | Overrides the image's command. |
| `port` | `int32` | The port the application listens on; the public edge stays 443. |
| `exposure` | `ServiceExposure` | Who can reach the Service; default PUBLIC. One of `public`, `internal`. |
| `size` | `InstanceSize` | The size of each instance; default the plan's. One of `nano`, `micro`, `small`, `standard`, `large`, `xlarge`, `xxlarge`. |
| `scaling` | `ServiceScaling` | Instance bounds. |
| `health` | `ServiceHealth` | How instances are probed. |
| `env` | `map<string, string>` | Plain environment variables. Secret values bind through `secret_env`, never here. |
| `secret_env` | `map<string, string>` | Environment variables bound to Sylphx Secrets: variable name to Secret name. The value never enters the spec. |
| `regions` | `string[]` | Regions to run in; default the project's home region. |

### ServiceStatus

| Field | Type | What it is |
| --- | --- | --- |
| `observed_generation` | `int64` | The generation this status was computed from. Output only. |
| `conditions` | `Condition[]` | Ready, Reconciling, Stalled. Output only. |
| `uri` | `string` | The default URL: `https://<ref>.sylphx.app`, or `*.unclaimed.sylphx.app` for an unclaimed project. Output only. |
| `release` | `string` | The Sylphx Release now serving. Output only. |
| `image` | `string` | The image digest now serving. Output only. |
| `rollout` | `string` | The Rollout in progress, if any. Output only. |
| `ready_instances` | `int32` | Instances passing health, summed over cells. Output only. |

### ServiceSource

| Field | Type | What it is |
| --- | --- | --- |
| `source_link` | `string` | Build from this SourceLink's repository on every push to `branch`. One of the `source` group. |
| `image` | `string` | Run this Artifact, by digest: `registry.sylphx.net/<path>@sha256:<hex>`. One of the `source` group. |
| `branch` | `string` | The branch that ships to this Service; default the SourceLink's production branch. Ignored for `image`. |
| `build` | `ServiceBuild` | How Build turns the source into an image. Ignored for `image`. |

### ServiceScaling

| Field | Type | What it is |
| --- | --- | --- |
| `min_instances` | `int32` | Instances kept running with no traffic; 0 idles to zero and wakes on request. |
| `max_instances` | `int32` | Instances at most; 0 means the plan's limit. |

### ServiceHealth

| Field | Type | What it is |
| --- | --- | --- |
| `protocol` | `HealthProtocol` | How to probe. Required. One of `http`, `tcp`. |
| `path` | `string` | The HTTP path to probe when `protocol` is HTTP. |
| `startup_timeout` | `duration` | How long a new instance may take to pass its first probe. |

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

### ServiceBuild

| Field | Type | What it is |
| --- | --- | --- |
| `root_directory` | `string` | The directory inside the repository to build; default the root. |
| `dockerfile` | `string` | A Dockerfile path relative to `root_directory`; unset lets the zero-config frontend detect the stack. |
| `build_class` | `string` | The Build class, `sylphx-<os>-<size>`; default `sylphx-linux-standard`. |

## 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.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.

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

## Examples

**cURL**

```curl
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

```ts
const response = await sylphx.hosting.services.get({ name: 'orgs/acme/projects/shop/envs/production/services/service' })
```

**Rust**

```rust
let mut req = sylphx::hosting::GetServiceRequest::default();
req.name = "orgs/acme/projects/shop/envs/production/services/service".to_string();
let response = sx.hosting().services().get(req).await?;
```

**CLI**

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

**Terraform**

```hcl
data "sylphx_hosting_service" "service" {
  name = "orgs/acme/projects/shop/envs/production/services/service"
}
```

**MCP**

```json
{ "method_id": "hosting.services.get", "args": {"name":"orgs/acme/projects/shop/envs/production/services/service"} }
```