Access Controls

When a dedicated IPFS gateway is configured to be private, an API token can also be generated and attached to the gateway. In this mode, the user or application must present the API token when making a request to successfully authorize the request.

Creating an API token

  1. Select a Dedicated IPFS Gateway from the Gateways page of your dashboard.

  2. In the top right corner, select the orange Authorization button.

  3. A modal will pop up. Here you can add, update, and remove API tokens.

Using an API token

Filebase has made it convenient to pass API tokens when making HTTP requests to dedicated IPFS gateways. Users have two options for including the token:

  • Query String Parameter: Users can append the filebaseGatewayToken query string parameter to the URL when making an HTTP request to the dedicated gateway. For example:

https://gateway.myfilebase.com/ipfs/QmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR?filebaseGatewayToken=your_token_here
  • Header: Users can also include the x-filebase-gateway-token header in their HTTP request. The token should be set as the header value. For example:

x-filebase-gateway-token: your_token_here

Last updated