Skip to Content

Relays

Proxy external APIs through Picklayer with connectors (upstream services) and routes (endpoint mappings).

Connectors

OperationGraphQL
List connectorsrelay_connectors(where: {application_id: {_eq: $appId}, enabled: {_eq: true}}, order_by: {created_at: desc})
Create connectorinsert_relay_connectors_one(object: {name, provider, base_url, auth_type, auth_config, default_headers, rate_limit, timeout_seconds, ...})
Update connectorupdate_relay_connectors_by_pk(pk_columns: {id: $id}, _set: {name, base_url, auth_type, auth_config, rate_limit, ...})
Delete connectorupdate_relay_connectors_by_pk(pk_columns: {id: $id}, _set: {enabled: false}) (soft-delete)
Create secretinsert_relay_connector_secrets_one(object: {connector_id, secret_name, ...})
Update secretupdate_relay_connector_secrets_by_pk(pk_columns: {id: $id}, _set: {secret_name, is_active, ...})

Routes

OperationGraphQL
List routesrelay_routes(where: {application_id: {_eq: $appId}, deleted: {_neq: true}}, order_by: {created_at: desc})
Create routeinsert_relay_routes_one(object: {connector_id, name, path, method, request_template, body_template, response_transform, qps_limit, cache_ttl_seconds, ...})
Update routeupdate_relay_routes_by_pk(pk_columns: {id: $id}, _set: {name, path, method, enabled, ...})
Delete routeupdate_relay_routes_by_pk(pk_columns: {id: $id}, _set: {deleted: true}) (soft-delete)
Active routes by connectorrelay_routes(where: {connector_id: {_eq: $connectorId}, enabled: {_eq: true}})

For route response caching, omit cache_ttl_seconds or set it to null to keep caching disabled. A positive cache_ttl_seconds value explicitly opts the route into caching for that TTL.

Last updated on