Skip to main content
GET
/
projects
/
{project_id}
/
services
List All Services
curl --request GET \
  --url https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services
[
  {
    "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"

Response

A list of services.

​
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

​
metadata
object

Additional metadata for the service

​
endpoint
object
​
vpcEndpoint
object | null

VPC endpoint configuration if available

​
forked_from
object
​
ha_replicas
object
​
connection_pooler
object
​
read_replica_sets
object[]