Get a Service

Retrieves the details of a specific service by its ID.

GET /projects/{project_id}/services/{service_id}

Try it

Get a Service

cURL

curl --request GET \
  --url https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}

200

{
  "service_id": "<string>",
  "project_id": "<string>",
  "name": "<string>",
  "region_code": "us-east-1",
  "service_type": "TIMESCALEDB",
  "created": "2023-11-07T05:31:56Z",
  "initial_password": "a-very-secure-initial-password",
  "paused": true,
  "status": "QUEUED",
  "resources": [
    {
      "id": "<string>",
      "spec": {
        "cpu_millis": 123,
        "memory_gbs": 123,
        "volume_type": "<string>"
      }
    }
  ],
  "metadata": {
    "environment": "<string>"
  },
  "endpoint": {
    "host": "my-service.com",
    "port": 8080
  },
  "vpcEndpoint": {},
  "forked_from": {
    "project_id": "asda1b2c3",
    "service_id": "bbss422fg",
    "is_standby": false
  },
  "ha_replicas": {
    "sync_replica_count": 1,
    "replica_count": 1
  },
  "connection_pooler": {
    "endpoint": {
      "host": "my-service.com",
      "port": 8080
    }
  },
  "read_replica_sets": [
    {
      "id": "alb8jicdpr",
      "name": "reporting-replica-1",
      "status": "active",
      "nodes": 2,
      "cpu_millis": 250,
      "memory_gbs": 1,
      "metadata": {
        "environment": "<string>"
      },
      "endpoint": {
        "host": "my-service.com",
        "port": 8080
      },
      "connection_pooler": {
        "endpoint": {
          "host": "my-service.com",
          "port": 8080
        }
      }
    }
  ]
}

Path Parameters

project_id · string · required

The unique identifier of the project.

Example:

"rp1pz7uyae"

service_id · string · required

The unique identifier of the service.

Example:

"d1k5vk7hf2"

Response

200

application/json

Service details.

service_id · string

The unique identifier for the service.

project_id · string

The project this service belongs to.

name · string

The name of the service.

region_code · string

The cloud region where the service is hosted.

Example:

"us-east-1"

service_type · enum<string>

The type of the service.

Available options: TIMESCALEDB, POSTGRES, VECTOR

created · string<date-time>

Creation timestamp

initial_password · string<password>

The initial password for the service.

Example:

"a-very-secure-initial-password"

paused · boolean

Whether the service is paused

status · enum<string>

Current status of the service

Available options: QUEUED, DELETING, CONFIGURING, READY, DELETED, UNSTABLE, PAUSING, PAUSED, RESUMING, UPGRADING, OPTIMIZING

resources · object[]

List of resources allocated to the service

Show child attributes

resources. id · string

Resource identifier

resources. spec · object

Resource specification

Show child attributes

resources.spec. cpu_millis · integer

CPU allocation in millicores

resources.spec. memory_gbs · integer

Memory allocation in gigabytes

resources.spec. volume_type · string

Type of storage volume

metadata · object

Additional metadata for the service

Show child attributes

metadata. environment · string

Environment tag for the service

endpoint · object

Show child attributes

endpoint. host · string

Example:

"my-service.com"

endpoint. port · integer

Example:

8080

vpcEndpoint · object

VPC endpoint configuration if available

forked_from · object

Show child attributes

forked_from. project_id · string

Example:

"asda1b2c3"

forked_from. service_id · string

Example:

"bbss422fg"

forked_from. is_standby · boolean

Example:

false

ha_replicas · object

Show child attributes

ha_replicas. sync_replica_count · integer

Number of synchronous high-availability replicas.

Example:

1

ha_replicas. replica_count · integer

Number of high-availability replicas (all replicas are asynchronous by default).

Example:

1

connection_pooler · object

Show child attributes

connection_pooler. endpoint · object

Show child attributes

connection_pooler.endpoint. host · string

Example:

"my-service.com"

connection_pooler.endpoint. port · integer

Example:

8080

read_replica_sets · object[]

Show child attributes

read_replica_sets. id · string

Example:

"alb8jicdpr"

read_replica_sets. name · string

Example:

"reporting-replica-1"

read_replica_sets. status · enum<string>

Available options: creating, active, resizing, deleting, error

Example:

"active"

read_replica_sets. nodes · integer

Number of nodes in the replica set.

Example:

2

read_replica_sets. cpu_millis · integer

CPU allocation in milli-cores.

Example:

250

read_replica_sets. memory_gbs · integer

Memory allocation in gigabytes.

Example:

1

read_replica_sets. metadata · object

Additional metadata for the read replica set

Show child attributes

read_replica_sets.metadata. environment · string

Environment tag for the read replica set

read_replica_sets. endpoint · object

Show child attributes

read_replica_sets.endpoint. host · string

Example:

"my-service.com"

read_replica_sets.endpoint. port · integer

Example:

8080

read_replica_sets. connection_pooler · object

Show child attributes

read_replica_sets.connection_pooler. endpoint · object

Show child attributes

read_replica_sets.connection_pooler.endpoint. host · string

Example:

"my-service.com"

read_replica_sets.connection_pooler.endpoint. port · integer

Example:

8080