Install an integration

curl --request POST \
  --url https://api.example.com/connections/install \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration_id": "<string>",
  "label": "<string>",
  "credential_ref": "<string>",
  "configuration": {}
}
'

{
  "connection_id": "<string>",
  "credential_id": "<string>",
  "activity_id": "<string>"
}

Connections

Install an integration

Server-side sibling of the browser consent flow at POST /integrations/:id/install. Skips the HTML consent screen — admin-only — so operators and tooling can install connections non-interactively. Body carries integration_id, an optional label, an optional credential_ref, and an optional configuration bag that seeds the new connection’s properties.configuration (e.g. upstream_base_url_override for per-host upstream targeting). Returns the connection id, the seed runtime credential id, and the system.activity row id from the install pipeline. Same compensating-write pipeline as the HTML path; same audit trail.

POST

connections

install

curl --request POST \
  --url https://api.example.com/connections/install \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration_id": "<string>",
  "label": "<string>",
  "credential_ref": "<string>",
  "configuration": {}
}
'

{
  "connection_id": "<string>",
  "credential_id": "<string>",
  "activity_id": "<string>"
}

Authorizations

Authorization

string

header

required

Pass an API key (marfa_k1_...) or OAuth access token (marfa_at_...)

Body

application/json

integration_id

string

required

label

string

credential_ref

string

configuration

object

Show child attributes

Response

Connection installed. Returns the new connection id, seed credential id, and activity id.

connection_id

string

required

credential_id

string

required

activity_id

string

required

Introspect a leased token Preview event dispatch envelopes

Documentation Index

Authorizations

Body

Response