Retrieve a project
curl --request GET \
--url https://us.getconvoy.cloud/api/v1/projects/{projectID} \
--header 'Authorization: <api-key>'import requests
url = "https://us.getconvoy.cloud/api/v1/projects/{projectID}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://us.getconvoy.cloud/api/v1/projects/{projectID}', 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://us.getconvoy.cloud/api/v1/projects/{projectID}",
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: <api-key>"
],
]);
$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://us.getconvoy.cloud/api/v1/projects/{projectID}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://us.getconvoy.cloud/api/v1/projects/{projectID}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.getconvoy.cloud/api/v1/projects/{projectID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": "<string>",
"status": true,
"data": {
"config": {
"add_event_id_trace_headers": true,
"circuit_breaker": {
"consecutive_failure_threshold": 123,
"error_timeout": 123,
"failure_threshold": 123,
"minimum_request_count": 123,
"observability_window": 123,
"sample_rate": 123,
"success_threshold": 123
},
"disable_endpoint": true,
"max_payload_read_size": 123,
"meta_event": {
"event_type": [
"<string>"
],
"is_enabled": true,
"pub_sub": {
"amqp": {
"host": "<string>",
"auth": {
"password": "<string>",
"user": "<string>"
},
"bindedExchange": "<string>",
"deadLetterExchange": "<string>",
"port": "<string>",
"queue": "<string>",
"routingKey": "<string>",
"schema": "<string>",
"vhost": "<string>"
},
"google": {
"project_id": "<string>",
"service_account": [
123
],
"subscription_id": "<string>"
},
"kafka": {
"auth": {
"hash": "<string>",
"password": "<string>",
"tls": true,
"type": "<string>",
"username": "<string>"
},
"brokers": [
"<string>"
],
"consumer_group_id": "<string>",
"topic_name": "<string>"
},
"sqs": {
"access_key_id": "<string>",
"default_region": "<string>",
"endpoint": "<string>",
"queue_name": "<string>",
"secret_key": "<string>"
},
"workers": 123
},
"secret": "<string>",
"url": "<string>"
},
"multiple_endpoint_subscriptions": true,
"ratelimit": {
"count": 123,
"duration": 123
},
"replay_attacks_prevention_enabled": true,
"search_policy": "<string>",
"signature": {
"header": "X-Convoy-Signature",
"versions": [
{
"created_at": "<string>",
"hash": "<string>",
"uid": "<string>"
}
]
},
"ssl": {
"enforce_secure_endpoints": true
},
"strategy": {
"duration": 123,
"retry_count": 123
}
},
"created_at": "<string>",
"deleted_at": "<string>",
"logo_url": "<string>",
"name": "<string>",
"organisation_id": "<string>",
"retained_events": 123,
"statistics": {
"endpoints_exist": true,
"events_exist": true,
"sources_exist": true,
"subscriptions_exist": true
},
"uid": "<string>",
"updated_at": "<string>"
}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}Projects
Retrieve a project
This endpoint fetches a project by its id
GET
/
v1
/
projects
/
{projectID}
Retrieve a project
curl --request GET \
--url https://us.getconvoy.cloud/api/v1/projects/{projectID} \
--header 'Authorization: <api-key>'import requests
url = "https://us.getconvoy.cloud/api/v1/projects/{projectID}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://us.getconvoy.cloud/api/v1/projects/{projectID}', 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://us.getconvoy.cloud/api/v1/projects/{projectID}",
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: <api-key>"
],
]);
$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://us.getconvoy.cloud/api/v1/projects/{projectID}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://us.getconvoy.cloud/api/v1/projects/{projectID}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.getconvoy.cloud/api/v1/projects/{projectID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": "<string>",
"status": true,
"data": {
"config": {
"add_event_id_trace_headers": true,
"circuit_breaker": {
"consecutive_failure_threshold": 123,
"error_timeout": 123,
"failure_threshold": 123,
"minimum_request_count": 123,
"observability_window": 123,
"sample_rate": 123,
"success_threshold": 123
},
"disable_endpoint": true,
"max_payload_read_size": 123,
"meta_event": {
"event_type": [
"<string>"
],
"is_enabled": true,
"pub_sub": {
"amqp": {
"host": "<string>",
"auth": {
"password": "<string>",
"user": "<string>"
},
"bindedExchange": "<string>",
"deadLetterExchange": "<string>",
"port": "<string>",
"queue": "<string>",
"routingKey": "<string>",
"schema": "<string>",
"vhost": "<string>"
},
"google": {
"project_id": "<string>",
"service_account": [
123
],
"subscription_id": "<string>"
},
"kafka": {
"auth": {
"hash": "<string>",
"password": "<string>",
"tls": true,
"type": "<string>",
"username": "<string>"
},
"brokers": [
"<string>"
],
"consumer_group_id": "<string>",
"topic_name": "<string>"
},
"sqs": {
"access_key_id": "<string>",
"default_region": "<string>",
"endpoint": "<string>",
"queue_name": "<string>",
"secret_key": "<string>"
},
"workers": 123
},
"secret": "<string>",
"url": "<string>"
},
"multiple_endpoint_subscriptions": true,
"ratelimit": {
"count": 123,
"duration": 123
},
"replay_attacks_prevention_enabled": true,
"search_policy": "<string>",
"signature": {
"header": "X-Convoy-Signature",
"versions": [
{
"created_at": "<string>",
"hash": "<string>",
"uid": "<string>"
}
]
},
"ssl": {
"enforce_secure_endpoints": true
},
"strategy": {
"duration": 123,
"retry_count": 123
}
},
"created_at": "<string>",
"deleted_at": "<string>",
"logo_url": "<string>",
"name": "<string>",
"organisation_id": "<string>",
"retained_events": 123,
"statistics": {
"endpoints_exist": true,
"events_exist": true,
"sources_exist": true,
"subscriptions_exist": true
},
"uid": "<string>",
"updated_at": "<string>"
}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}Was this page helpful?
⌘I