Private API (Generic)

OverviewCopy Anchor Link

Pre-built toolingCopy Anchor Link

No pre-built syncs or actions available yet.

When to use itCopy Anchor Link

Use Private API (Generic) for APIs that authenticate with an API key but do not use Authorization: Bearer <key>. Unlike Private API (Bearer Auth), you configure per integration how the proxy presents the key:

• Key placement: header or query param. Prefer header — keys sent as a query param can be exposed in upstream, proxy, and CDN logs.
• Key name: the header or query-param name, e.g. Authorization, x-api-key, api_key.
• Value template: how the key is wrapped, using ${apiKey} as the placeholder, e.g. ${apiKey}, Bearer ${apiKey}, Api-Key ${apiKey}.
• Base URL: the upstream API the proxy calls.
• API key label: the label end users see for the key field in the Connect UI.

The key is vaulted by Tenklo and injected by the proxy, so raw credentials never need to leave Tenklo.

Important limitationsCopy Anchor Link

• Limited functionality: Private API (Generic) is limited to storing and injecting a single API key. Because it's generic, many advanced Tenklo features are not available for it.
• Base URL required: You must set the base URL on the integration; there is no predefined base URL like other integrations.
• Recommended use cases only: The only recommended use case for private API integrations is to store credentials for internal/customer-specific APIs that cannot be added to the Tenklo catalog.
• For all other use cases: We recommend contributing the API to Tenklo or requesting it be added by us.

Create the integration programmaticallyCopy Anchor Link

You can create and update a Private API (Generic) integration from the dashboard, or programmatically with the API or SDK by passing its configuration in integration_config.

await nango.createIntegration({
    provider: 'private-api-generic',
    unique_key: 'acme-internal',
    display_name: 'Acme Internal API',
    integration_config: {
        baseUrl: 'https://api.acme.com',
        keyPlacement: 'header',
        keyName: 'Authorization',
        valueTemplate: 'Api-Key ${apiKey}',
        keyLabel: 'Acme API Key'
    }
});

Configuration fields:

To change the configuration later, send the fields you want to update with Update an integration (PATCH /integrations/{uniqueKey}) or nango.updateIntegration().

Setup guideCopy Anchor Link

No setup guide yet.

Useful linksCopy Anchor Link

No useful links yet.

API gotchasCopy Anchor Link