Skip to main content
GET
/
api
/
service-bridges
/
{id}
Get ServiceBridgeMetadata by ID
curl --request GET \
  --url https://platform.kodexa.ai/api/service-bridges/{id} \
  --header 'x-api-key: <api-key>'
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "extensionPackRef": "<string>",
  "id": "<string>",
  "metadata": {
    "auth": {
      "clientId": "<string>",
      "clientSecret": "<string>",
      "headerName": "<string>",
      "headerPrefix": "<string>",
      "requestBody": {},
      "requestFormat": "<string>",
      "responseMapping": {
        "accessToken": "<string>",
        "expiresIn": "<string>"
      },
      "tokenCacheBufferSeconds": 123,
      "tokenUrl": "<string>",
      "type": "<string>"
    },
    "baseUrl": "<string>",
    "checksum": "<string>",
    "defaultHeaders": [
      {
        "name": "<string>",
        "secretRef": "<string>",
        "value": "<string>"
      }
    ],
    "deleteProtection": true,
    "description": "<string>",
    "endpoints": [
      {
        "cacheEnabled": true,
        "cacheTtlSeconds": 123,
        "description": "<string>",
        "headers": [
          {
            "name": "<string>",
            "secretRef": "<string>",
            "value": "<string>"
          }
        ],
        "initScope": "<string>",
        "initScript": "<string>",
        "method": "<string>",
        "name": "<string>",
        "path": "<string>",
        "postReplyScript": "<string>",
        "preSendScript": "<string>",
        "requestSchema": {},
        "responseSchema": {}
      }
    ],
    "icon": "<string>",
    "imageUrl": "<string>",
    "overviewMarkdown": "<string>",
    "provider": "<string>",
    "providerImageUrl": "<string>",
    "providerUrl": "<string>"
  },
  "name": "<string>",
  "organizationId": "<string>",
  "publicAccess": true,
  "slug": "<string>",
  "template": true,
  "type": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "yamlSource": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.kodexa.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

​
id
string<uuid>
required

Unique identifier (UUID) of the resource.

Response

The ServiceBridgeMetadata

​
changeSequence
integer<int32>
​
createdOn
string<date-time>
​
deprecated
boolean
​
extensionPackRef
string
​
id
string
​
metadata
object
​
name
string
​
organizationId
string
​
publicAccess
boolean
​
slug
string
​
template
boolean
​
type
string
​
updatedOn
string<date-time>
​
uuid
string
​
yamlSource
string | null