Carbon

Integration

The integration resource.

Basehttps://rest.carbon.ms/integration
GET/integration

List integrations

Retrieve a paginated list of integrations. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/integration
curl --request GET \
  --url 'https://rest.carbon.ms/integration?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "jsonschema": "string"
  }
]
GET/integration

Retrieve a integration

Fetch a single integration by filtering on `id`.

Query parameters

idstring

Match on the integration's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/integration
curl --request GET \
  --url 'https://rest.carbon.ms/integration?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "jsonschema": "string"
}
POST/integration

Create a integration

Create a new integration.

Body parameters

jsonschemaobjectrequired
POSThttps://rest.carbon.ms/integration
curl --request POST \
  --url https://rest.carbon.ms/integration \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"jsonschema":"string"}'
Response
{
  "id": "abc123def456",
  "jsonschema": "string"
}
PATCH/integration

Update a integration

Update an existing integration, matched on `id`.

Body parameters

jsonschemaobjectrequired
PATCHhttps://rest.carbon.ms/integration
curl --request PATCH \
  --url 'https://rest.carbon.ms/integration?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"jsonschema":"string"}'
Response
{
  "id": "abc123def456",
  "jsonschema": "string"
}
DELETE/integration

Delete a integration

Delete a integration, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the integration to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/integration
curl --request DELETE \
  --url 'https://rest.carbon.ms/integration?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content