List All Services
curl --request GET \
--url https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body[
{
"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
}
}
}
]
}
]{
"code": "<string>",
"message": "<string>"
}List All Services
Retrieves a list of all services within a specific project.
GET
/
projects
/
{project_id}
/
services
List All Services
curl --request GET \
--url https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body[
{
"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
}
}
}
]
}
]{
"code": "<string>",
"message": "<string>"
}Authorizations
HTTP Basic Authentication using your Tiger Cloud public key and secret key.
Format: Authorization: Basic <base64(public_key:secret_key)>
Example:
curl -X GET "https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services" \ -H "Authorization: Basic $(echo -n 'your_public_key:your_secret_key' | base64)"
Path Parameters
The unique identifier of the project.
Example:
"rp1pz7uyae"
Response
A list of services.
The unique identifier for the service.
The project this service belongs to.
The name of the service.
The cloud region where the service is hosted.
Example:
"us-east-1"
The type of the service.
Available options:
TIMESCALEDB, POSTGRES, VECTOR Creation timestamp
The initial password for the service.
Example:
"a-very-secure-initial-password"
Whether the service is paused
Current status of the service
Available options:
QUEUED, DELETING, CONFIGURING, READY, DELETED, UNSTABLE, PAUSING, PAUSED, RESUMING, UPGRADING, OPTIMIZING List of resources allocated to the service
Show child attributes
Show child attributes
Additional metadata for the service
Show child attributes
Show child attributes
Show child attributes
Show child attributes
VPC endpoint configuration if available
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes