FunnelFlux Pro API DocumentsFunnelFlux Pro API Documents
  • Changelog
  • Status
  • Dashboard
  • Documentation
  • Authentication
  • Domains
  • Assets
  • Reporting
Information
Authentication
    Access token validationpostRegister a new user (Auth0 provider only)postPassword-based login (legacy)postSend a password reset email (Auth0 provider only)post
Integrations
    List integrationsgetGet integrationgetDelete integrationdeleteRename integrationpatchStart integration OAuthpostComplete integration OAuthgetList integration capabilitiesgetReauthorize integrationpostList integration ad accountsgetList integration conversion goalsgetTrigger integration syncpostList integration sync job statusget
API Keys
    List customer API keysgetCreate a customer API keypostRevoke a customer API keydelete
Schemas
FunnelFlux Authentication API
FunnelFlux Authentication API

API Keys

Download schema

Customer API keys for the signed-in account. Session credential only.


List customer API keys

GET
https://api.funnelflux.pro/v1
/api-keys

Lists the signed-in account's active API keys, oldest first. Revoked keys are not returned. Each entry carries masked rather than the secret, which is shown only once by POST /api-keys.

Session credential only; an API key or a legacy Auth0 token answers 403 session_required.

List customer API keys › Responses

The account's active API keys.

APIKeyList
​APIKeySummary[] · required

Active keys, oldest first.

GET/api-keys
curl --request GET \ --url https://api.funnelflux.pro/v1/api-keys
Example Responses
{ "keys": [ { "id": "id", "name": "name", "created_at": "2024-08-25T15:00:00Z", "masked": "masked" } ] }
json
application/json

Create a customer API key

POST
https://api.funnelflux.pro/v1
/api-keys

Creates an API key for the signed-in account and returns its plaintext secret once. Only the SHA-256 hash of the secret is stored: neither this endpoint nor GET /api-keys ever returns it again, and later reads carry masked instead.

Session credential only. An API key or a legacy Auth0 token in the Authorization header answers 403 session_required and nothing is created. An account may hold at most 50 active keys; the 51st answers 409 api_key_limit_reached until one is revoked.

Create a customer API key › Request Body

APIKeyCreateRequest
name
​string · required

Label for the key, at most 255 characters after trimming whitespace. Shown in GET /api-keys.

Example: CI deploy

Create a customer API key › Responses

The key was created. The body carries the one-time plaintext secret, so the response is marked no-store.

APIKeyIssued
id
​string · required

Key id, used by DELETE /api-keys/{id}.

Example: key_abcdefghijklmnopqrstuv
name
​string · required
created_at
​string · date-time · required
masked
​string · required

Display form of the key, ffk_•••• plus the last four id characters. Safe to show.

Example: ffk_••••stuv
secret
​string · required

The plaintext API key, sent as Authorization: Bearer <secret>. Returned once, only here; only its SHA-256 hash is stored.

Example: ffk_q3JvY2tldFNlY3JldEZvckZ1bm5lbEZsdXhQcm9EdGVzdA
POST/api-keys
curl --request POST \ --url https://api.funnelflux.pro/v1/api-keys \ --header 'Content-Type: application/json' \ --data ' { "name": "CI deploy" } '
Example Request Body
{ "name": "CI deploy" }
json
Example Responses
{ "id": "key_abcdefghijklmnopqrstuv", "name": "name", "created_at": "2024-08-25T15:00:00Z", "masked": "ffk_••••stuv", "secret": "ffk_q3JvY2tldFNlY3JldEZvckZ1bm5lbEZsdXhQcm9EdGVzdA" }
json
application/json

Revoke a customer API key

DELETE
https://api.funnelflux.pro/v1
/api-keys/{id}

Revokes one of the signed-in account's API keys by id. Revocation is permanent and takes effect immediately: the key stops resolving even if a replica cached it. Revoking an already revoked key answers 404.

Session credential only; an API key or a legacy Auth0 token answers 403 session_required.

Revoke a customer API key › path Parameters

id
​string · required

API key id, as returned by POST /api-keys and GET /api-keys.

Revoke a customer API key › Responses

The key is revoked.

No data returned
DELETE/api-keys/{id}
curl --request DELETE \ --url https://api.funnelflux.pro/v1/api-keys/:id
Example Responses
No example specified for this content type

Integrations