fingerlydocs
fingerly.io Log inDashboard
API reference

Proxy keys

List, issue and revoke the proxy keys your first-party proxies authenticate with. Admin management keys only.

Proxy keys let a proxy on your own domain forward identify 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.
    11 child fields
    • idstring
      The key's ID.
    • namestring
      The key's name.
    • environmentstring
      production, staging or development.
    • regionstring
      The key's data region.
    • prefixstring
      The start of the secret, such as fly_px_us_production.
    • last4string
      The last four characters of the secret.
    • statusstring
      active or revoked.
    • last_used_atstring
      When the key last authenticated a request.
    • 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 key is called.
  • environmentstringrequired
    The environment of the public keys it will forward: production, staging or development.

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

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.

Last updated