Skip to main content
GET
/
api
/
v1
/
workspaces
/
{id}
/
services
/
{name}
Get a single workspace service by name.
curl --request GET \
  --url https://api.rigbox.dev/api/v1/workspaces/{id}/services/{name} \
  --header 'Authorization: Bearer <token>'
{
  "created_at": "2023-11-07T05:31:56Z",
  "exposed": true,
  "health_cmd": "<string>",
  "id": "<string>",
  "kind": "<string>",
  "name": "<string>",
  "source": "<string>",
  "status": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "workspace_id": "<string>",
  "log_sources": [
    {
      "source_ref": "<string>",
      "source_type": "<string>",
      "display_name": "<string>",
      "is_primary": true
    }
  ],
  "port": 123,
  "unit_name": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.rigbox.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Workspace ID

​
name
string
required

Service name

Response

200 - application/json

Service details

Runtime backing service instance tracked for health monitoring. Distinct from ServiceSpec (which generates systemd units for custom processes). WorkspaceService tracks apt-managed daemons like PostgreSQL, Redis, RabbitMQ.

​
created_at
string<date-time>
required
​
exposed
boolean
required
​
health_cmd
string
required
​
id
string
required
​
kind
string
required
​
name
string
required
​
source
string
required
​
status
string
required
​
updated_at
string<date-time>
required
​
workspace_id
string
required
​
log_sources
object[]
​
port
integer<int32> | null
​
unit_name
string | null