Create a project
curl --request POST \
--url https://us.getconvoy.cloud/api/v1/projects \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--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,
"secret": "<string>",
"type": "<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>",
"encoding": "<string>",
"hash": "<string>",
"uid": "<string>"
}
]
},
"ssl": {
"enforce_secure_endpoints": true
},
"strategy": {
"duration": 123,
"retry_count": 123,
"type": "<string>"
}
},
"logo_url": "<string>",
"name": "<string>",
"type": "<string>"
}
'import requests
url = "https://us.getconvoy.cloud/api/v1/projects"
payload = {
"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,
"secret": "<string>",
"type": "<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>",
"encoding": "<string>",
"hash": "<string>",
"uid": "<string>"
}
]
},
"ssl": { "enforce_secure_endpoints": True },
"strategy": {
"duration": 123,
"retry_count": 123,
"type": "<string>"
}
},
"logo_url": "<string>",
"name": "<string>",
"type": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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,
secret: '<string>',
type: '<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>',
encoding: '<string>',
hash: '<string>',
uid: '<string>'
}
]
},
ssl: {enforce_secure_endpoints: true},
strategy: {duration: 123, retry_count: 123, type: '<string>'}
},
logo_url: '<string>',
name: '<string>',
type: '<string>'
})
};
fetch('https://us.getconvoy.cloud/api/v1/projects', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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,
'secret' => '<string>',
'type' => '<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>',
'encoding' => '<string>',
'hash' => '<string>',
'uid' => '<string>'
]
]
],
'ssl' => [
'enforce_secure_endpoints' => true
],
'strategy' => [
'duration' => 123,
'retry_count' => 123,
'type' => '<string>'
]
],
'logo_url' => '<string>',
'name' => '<string>',
'type' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://us.getconvoy.cloud/api/v1/projects"
payload := strings.NewReader("{\n \"config\": {\n \"add_event_id_trace_headers\": true,\n \"circuit_breaker\": {\n \"consecutive_failure_threshold\": 123,\n \"error_timeout\": 123,\n \"failure_threshold\": 123,\n \"minimum_request_count\": 123,\n \"observability_window\": 123,\n \"sample_rate\": 123,\n \"success_threshold\": 123\n },\n \"disable_endpoint\": true,\n \"max_payload_read_size\": 123,\n \"meta_event\": {\n \"event_type\": [\n \"<string>\"\n ],\n \"is_enabled\": true,\n \"secret\": \"<string>\",\n \"type\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"multiple_endpoint_subscriptions\": true,\n \"ratelimit\": {\n \"count\": 123,\n \"duration\": 123\n },\n \"replay_attacks_prevention_enabled\": true,\n \"search_policy\": \"<string>\",\n \"signature\": {\n \"header\": \"X-Convoy-Signature\",\n \"versions\": [\n {\n \"created_at\": \"<string>\",\n \"encoding\": \"<string>\",\n \"hash\": \"<string>\",\n \"uid\": \"<string>\"\n }\n ]\n },\n \"ssl\": {\n \"enforce_secure_endpoints\": true\n },\n \"strategy\": {\n \"duration\": 123,\n \"retry_count\": 123,\n \"type\": \"<string>\"\n }\n },\n \"logo_url\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://us.getconvoy.cloud/api/v1/projects")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"add_event_id_trace_headers\": true,\n \"circuit_breaker\": {\n \"consecutive_failure_threshold\": 123,\n \"error_timeout\": 123,\n \"failure_threshold\": 123,\n \"minimum_request_count\": 123,\n \"observability_window\": 123,\n \"sample_rate\": 123,\n \"success_threshold\": 123\n },\n \"disable_endpoint\": true,\n \"max_payload_read_size\": 123,\n \"meta_event\": {\n \"event_type\": [\n \"<string>\"\n ],\n \"is_enabled\": true,\n \"secret\": \"<string>\",\n \"type\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"multiple_endpoint_subscriptions\": true,\n \"ratelimit\": {\n \"count\": 123,\n \"duration\": 123\n },\n \"replay_attacks_prevention_enabled\": true,\n \"search_policy\": \"<string>\",\n \"signature\": {\n \"header\": \"X-Convoy-Signature\",\n \"versions\": [\n {\n \"created_at\": \"<string>\",\n \"encoding\": \"<string>\",\n \"hash\": \"<string>\",\n \"uid\": \"<string>\"\n }\n ]\n },\n \"ssl\": {\n \"enforce_secure_endpoints\": true\n },\n \"strategy\": {\n \"duration\": 123,\n \"retry_count\": 123,\n \"type\": \"<string>\"\n }\n },\n \"logo_url\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.getconvoy.cloud/api/v1/projects")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"config\": {\n \"add_event_id_trace_headers\": true,\n \"circuit_breaker\": {\n \"consecutive_failure_threshold\": 123,\n \"error_timeout\": 123,\n \"failure_threshold\": 123,\n \"minimum_request_count\": 123,\n \"observability_window\": 123,\n \"sample_rate\": 123,\n \"success_threshold\": 123\n },\n \"disable_endpoint\": true,\n \"max_payload_read_size\": 123,\n \"meta_event\": {\n \"event_type\": [\n \"<string>\"\n ],\n \"is_enabled\": true,\n \"secret\": \"<string>\",\n \"type\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"multiple_endpoint_subscriptions\": true,\n \"ratelimit\": {\n \"count\": 123,\n \"duration\": 123\n },\n \"replay_attacks_prevention_enabled\": true,\n \"search_policy\": \"<string>\",\n \"signature\": {\n \"header\": \"X-Convoy-Signature\",\n \"versions\": [\n {\n \"created_at\": \"<string>\",\n \"encoding\": \"<string>\",\n \"hash\": \"<string>\",\n \"uid\": \"<string>\"\n }\n ]\n },\n \"ssl\": {\n \"enforce_secure_endpoints\": true\n },\n \"strategy\": {\n \"duration\": 123,\n \"retry_count\": 123,\n \"type\": \"<string>\"\n }\n },\n \"logo_url\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"status": true,
"data": {
"api_key": {
"created_at": "<string>",
"expires_at": "<string>",
"key": "<string>",
"key_type": "<string>",
"name": "<string>",
"role": {
"app": "<string>",
"project": "<string>"
},
"uid": "<string>",
"user_id": "<string>"
},
"project": {
"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": {}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}Projects
Create a project
This endpoint creates a project. Authenticate with a personal API key or JWT and pass the organisation id as the orgID query parameter. The response includes the project and a one-time project API key.
POST
/
v1
/
projects
Create a project
curl --request POST \
--url https://us.getconvoy.cloud/api/v1/projects \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--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,
"secret": "<string>",
"type": "<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>",
"encoding": "<string>",
"hash": "<string>",
"uid": "<string>"
}
]
},
"ssl": {
"enforce_secure_endpoints": true
},
"strategy": {
"duration": 123,
"retry_count": 123,
"type": "<string>"
}
},
"logo_url": "<string>",
"name": "<string>",
"type": "<string>"
}
'import requests
url = "https://us.getconvoy.cloud/api/v1/projects"
payload = {
"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,
"secret": "<string>",
"type": "<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>",
"encoding": "<string>",
"hash": "<string>",
"uid": "<string>"
}
]
},
"ssl": { "enforce_secure_endpoints": True },
"strategy": {
"duration": 123,
"retry_count": 123,
"type": "<string>"
}
},
"logo_url": "<string>",
"name": "<string>",
"type": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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,
secret: '<string>',
type: '<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>',
encoding: '<string>',
hash: '<string>',
uid: '<string>'
}
]
},
ssl: {enforce_secure_endpoints: true},
strategy: {duration: 123, retry_count: 123, type: '<string>'}
},
logo_url: '<string>',
name: '<string>',
type: '<string>'
})
};
fetch('https://us.getconvoy.cloud/api/v1/projects', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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,
'secret' => '<string>',
'type' => '<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>',
'encoding' => '<string>',
'hash' => '<string>',
'uid' => '<string>'
]
]
],
'ssl' => [
'enforce_secure_endpoints' => true
],
'strategy' => [
'duration' => 123,
'retry_count' => 123,
'type' => '<string>'
]
],
'logo_url' => '<string>',
'name' => '<string>',
'type' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://us.getconvoy.cloud/api/v1/projects"
payload := strings.NewReader("{\n \"config\": {\n \"add_event_id_trace_headers\": true,\n \"circuit_breaker\": {\n \"consecutive_failure_threshold\": 123,\n \"error_timeout\": 123,\n \"failure_threshold\": 123,\n \"minimum_request_count\": 123,\n \"observability_window\": 123,\n \"sample_rate\": 123,\n \"success_threshold\": 123\n },\n \"disable_endpoint\": true,\n \"max_payload_read_size\": 123,\n \"meta_event\": {\n \"event_type\": [\n \"<string>\"\n ],\n \"is_enabled\": true,\n \"secret\": \"<string>\",\n \"type\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"multiple_endpoint_subscriptions\": true,\n \"ratelimit\": {\n \"count\": 123,\n \"duration\": 123\n },\n \"replay_attacks_prevention_enabled\": true,\n \"search_policy\": \"<string>\",\n \"signature\": {\n \"header\": \"X-Convoy-Signature\",\n \"versions\": [\n {\n \"created_at\": \"<string>\",\n \"encoding\": \"<string>\",\n \"hash\": \"<string>\",\n \"uid\": \"<string>\"\n }\n ]\n },\n \"ssl\": {\n \"enforce_secure_endpoints\": true\n },\n \"strategy\": {\n \"duration\": 123,\n \"retry_count\": 123,\n \"type\": \"<string>\"\n }\n },\n \"logo_url\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://us.getconvoy.cloud/api/v1/projects")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"add_event_id_trace_headers\": true,\n \"circuit_breaker\": {\n \"consecutive_failure_threshold\": 123,\n \"error_timeout\": 123,\n \"failure_threshold\": 123,\n \"minimum_request_count\": 123,\n \"observability_window\": 123,\n \"sample_rate\": 123,\n \"success_threshold\": 123\n },\n \"disable_endpoint\": true,\n \"max_payload_read_size\": 123,\n \"meta_event\": {\n \"event_type\": [\n \"<string>\"\n ],\n \"is_enabled\": true,\n \"secret\": \"<string>\",\n \"type\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"multiple_endpoint_subscriptions\": true,\n \"ratelimit\": {\n \"count\": 123,\n \"duration\": 123\n },\n \"replay_attacks_prevention_enabled\": true,\n \"search_policy\": \"<string>\",\n \"signature\": {\n \"header\": \"X-Convoy-Signature\",\n \"versions\": [\n {\n \"created_at\": \"<string>\",\n \"encoding\": \"<string>\",\n \"hash\": \"<string>\",\n \"uid\": \"<string>\"\n }\n ]\n },\n \"ssl\": {\n \"enforce_secure_endpoints\": true\n },\n \"strategy\": {\n \"duration\": 123,\n \"retry_count\": 123,\n \"type\": \"<string>\"\n }\n },\n \"logo_url\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.getconvoy.cloud/api/v1/projects")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"config\": {\n \"add_event_id_trace_headers\": true,\n \"circuit_breaker\": {\n \"consecutive_failure_threshold\": 123,\n \"error_timeout\": 123,\n \"failure_threshold\": 123,\n \"minimum_request_count\": 123,\n \"observability_window\": 123,\n \"sample_rate\": 123,\n \"success_threshold\": 123\n },\n \"disable_endpoint\": true,\n \"max_payload_read_size\": 123,\n \"meta_event\": {\n \"event_type\": [\n \"<string>\"\n ],\n \"is_enabled\": true,\n \"secret\": \"<string>\",\n \"type\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"multiple_endpoint_subscriptions\": true,\n \"ratelimit\": {\n \"count\": 123,\n \"duration\": 123\n },\n \"replay_attacks_prevention_enabled\": true,\n \"search_policy\": \"<string>\",\n \"signature\": {\n \"header\": \"X-Convoy-Signature\",\n \"versions\": [\n {\n \"created_at\": \"<string>\",\n \"encoding\": \"<string>\",\n \"hash\": \"<string>\",\n \"uid\": \"<string>\"\n }\n ]\n },\n \"ssl\": {\n \"enforce_secure_endpoints\": true\n },\n \"strategy\": {\n \"duration\": 123,\n \"retry_count\": 123,\n \"type\": \"<string>\"\n }\n },\n \"logo_url\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"status": true,
"data": {
"api_key": {
"created_at": "<string>",
"expires_at": "<string>",
"key": "<string>",
"key_type": "<string>",
"name": "<string>",
"role": {
"app": "<string>",
"project": "<string>"
},
"uid": "<string>",
"user_id": "<string>"
},
"project": {
"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": {}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}Authorizations
Query Parameters
Organisation ID
Body
application/json
Project Details
Was this page helpful?
⌘I