Skip to main content
GET
/
v0
/
experimental
/
edges
/
{id}
Get a cross-service edge by ID.
curl --request GET \
  --url https://{hostname}.gable.ai/v0/experimental/edges/{id} \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://{hostname}.gable.ai/v0/experimental/edges/{id}"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://{hostname}.gable.ai/v0/experimental/edges/{id}', 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://{hostname}.gable.ai/v0/experimental/edges/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <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://{hostname}.gable.ai/v0/experimental/edges/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<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://{hostname}.gable.ai/v0/experimental/edges/{id}")
  .header("X-API-KEY", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{hostname}.gable.ai/v0/experimental/edges/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "edge": {
    "source": {
      "component_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "component_name": "<string>",
      "payload_name": "<string>",
      "kind": "<string>",
      "xgress_id": "<string>"
    },
    "destination": {
      "component_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "component_name": "<string>",
      "payload_name": "<string>",
      "kind": "<string>",
      "xgress_id": "<string>"
    },
    "field_mappings": [
      {
        "source_field": "<string>",
        "destination_field": "<string>",
        "notes": "<string>"
      }
    ],
    "id": "<string>",
    "kind": "cross_service",
    "namespace": "<string>"
  }
}
{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}
{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}
{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required

The edge ID.

Query Parameters

namespace
string

Optional namespace guard for the requested edge.

Response

Successful operation

edge
object
required

A cross-service edge connecting two components. This schema is used for both read (GET) and write (POST/PUT) operations to enable round-trip editing. Fields marked readOnly are returned by GET but ignored on POST/PUT. Fields marked writeOnly are accepted on POST/PUT but not returned in GET.