Menu
Platform
- Accounts and projects
- Regions
- Environments
- Keys and scopes
- Plans, usage and limits
- Errors
- API versions
- API reference
- CLI
- MCP
- Published CLI compatibility
- Terraform
- Management secret deletion
- API keys
- Artifacts
- Connection providers
- Connections
- Envs
- Key versions
- Keys
- Projects
- Secret versions
- Secrets
- Service enablements
- Token exchanges
- Trust policies
AI
Alerts and status pages
App store purchases
Credits
Database
Flags
Generated Assets
Hosting
Monitoring
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Queues
Realtime
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Probe a service observation
Performs one safe same-environment transport observation.
Performs one safe same-environment transport observation. Unlike a readiness read, this explicitly requested HTTP instrument may activate an idle service. No caller credential is forwarded to the workload.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/service_observations/service-observation:probe - Scope
hosting:read - Effect
read— nothing is written. - Collection service_observations
#Request
| Field | Type | What it is |
|---|---|---|
name | string | Same-environment service observation name. Required. |
method | string | GET or HEAD; defaults to HEAD. |
path | string | Canonical safe path; defaults to /healthz. |
expect_status | uint32[] | Allowed statuses; defaults to 200 through 299. |
expect_body | string | Bounded literal body assertion for GET. |
timeout | duration | 1, 2, 5 or 10 seconds; defaults to 10 seconds. |
#Response
| Field | Type | What it is |
|---|---|---|
outcome | string | up, unexpected_status, body_mismatch, dns_failure, tls_failure, network_failure, timeout or unknown. |
reason | string | Precise unknown or refusal reason, separate from outage. |
status | uint32 | Actual HTTP status, zero if no response was received. |
sample_time | timestamp | Server observation time. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.INVALID_FIELD— A field failed validation.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/service_observations/service-observation:probe" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'