fingerlydocs
fingerly.io Log inDashboard
API reference

Proxy keys

List, issue, update and revoke the proxy integrations your first-party proxies authenticate with, and move one to a new path. Admin keys only.

A proxy key belongs to a proxy integration: a proxy on your own site, the path it answers, and how it runs. The key lets that proxy forward the browser SDK's requests with the visitor's real details. See proxy integrations. Only admin management keys can manage them; a developer key answers 403.

Path parameter

  • organization_idstringrequired
    Your organization, from Describe the key. A path naming any other organization answers 404.

List proxy keys

GET/api/v1/management/organizations/{organization_id}/proxy-credentials Management key

Response

  • credentialsProxyKey[]
    Every proxy key, oldest first, revoked keys included.
    15 child fields
    • idstring
      The key's ID.
    • namestring
      The proxy's name.
    • environmentstring
      production, staging or development.
    • kindstring
      How the proxy runs: cloudflare_worker, server_sdk, vercel, netlify, aws_cloudfront, gcp_cloud_run, nginx, caddy, traefik, container or custom.
    • pathstring
      Where the browser SDK posts on your site, such as /k7x2qm4a.
    • prefixstring
      The start of the secret, such as fly_px_production.
    • last4string
      The last four characters of the secret.
    • statusstring
      active or revoked.
    • last_used_atstring
      When the key last authenticated a request. Omitted if never.
    • last_versionstring
      What the proxy last reported itself as, such as cloudflare-worker/0.2.0. Omitted until a proxy sends x-fingerly-proxy-version.
    • last_originstring
      The page origin last seen through the proxy. Omitted if never.
    • requests_30dinteger
      Requests the proxy forwarded over the last 30 days.
    • expires_atstring
      When the key stops working.
    • created_atstring
      When the key was issued.
    • revoked_atstring
      When the key was revoked.

Issue a proxy key

POST/api/v1/management/organizations/{organization_id}/proxy-credentials Management key

Body

  • namestringrequired
    What the proxy is called.
  • environmentstringrequired
    The environment of the public keys it will forward: production, staging or development.
  • kindstringDefault 'custom'
    How the proxy runs: cloudflare_worker, server_sdk, vercel, netlify, aws_cloudfront, gcp_cloud_run, nginx, caddy, traefik, container or custom. The dashboard prints the setup for the kind.
  • pathstring
    Where the browser SDK will post on your site. Omit it for a random one, such as /k7x2qm4a, which is what we recommend.

Answers 201 with credential, a proxy key as above, and secret, the whole key, shown once.

Update a proxy key

PATCH/api/v1/management/organizations/{organization_id}/proxy-credentials/{proxy_credential_id} Management key

Body

  • namestringrequired
    The proxy's name.
  • kindstringrequired
    How the proxy runs, one of the kinds above.
  • pathstring
    The new path. Omit it for a new random one.

Answers with the proxy key. The secret does not change: moving a proxy to a new path is a change on your side, not a new key. Send the current path to keep it.

Revoke a proxy key

POST/api/v1/management/organizations/{organization_id}/proxy-credentials/{proxy_credential_id}/revoke Management key

Refuses the key from the next request on, and answers with the revoked key.

Paths

A path must start with /, be 2 to 64 characters, and use only letters, digits and . _ ~ - /. A path a content blocker would match is refused with 422 and proxy_path_rejected, and error.message names the word, such as fingerly, fingerprint, fpjs, tracking, analytics, telemetry, metrics, stats, collect, events, identify, ingest, pixel, beacon, ads, log, sdk, visitor, fraud, device or bot. See why paths are random.

Last updated