connector-catalog-public@1.0.0
Public connector catalog
Read the catalog of connector types Apus has published and how ready each one is. No authentication required.
Built from the frozen contract, version 1.0.0. Frozen versions are never edited.
Operations
get/v1/public/connectors
Returns the whole catalog in one response, without pagination. Send If-None-Match with the ETag you hold to get 304 when nothing changed.
No authentication required · getPublicConnectorCatalog
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| If-None-Match | header | string | No |
Responses
200— The current catalog. An empty array is valid: nothing has been published yet.304— The catalog has not changed since the ETag you sent.500— The catalog could not be built. Treat it as no data, never as an empty catalog.
Data models
ConnectorCatalog
| Field | Type | Required | Description |
|---|---|---|---|
| contract | "connector-catalog-public/1.0.0" | Yes | The contract version being served. |
| generated_at | string (date-time) | Yes | When the catalog was built (UTC, RFC 3339). |
| connectors | PublicConnector[] | Yes | Every published type; may be empty. |
PublicConnector
| Field | Type | Required | Description |
|---|---|---|---|
| key | string | Yes | Permanent identifier of the connector type; safe to use as a link anchor. |
| name | string | Yes | Display name; do not match on it. |
| direction | inbound_api | webhook_out | polling_adapter | Yes | Data direction: in through an API, out through signed webhooks, or pulled on a schedule. |
| status | live | beta | roadmap | Yes | Readiness: live, beta or roadmap. |
| summary | string | No | Optional short description. |
| docs_url | string (uri) | No | Optional public documentation page for this type. |