🔐Endpoint Security: API Key Management

After creating a private endpoint on the Dashboard, users will be able to add and manage API Keys to further enhance application security and control. Users can add and delete API keys, as well as whitelisting domains and IPv4 addresses if they so choose.

After creating an API Key, you'll need include it in your requests. There are two ways to do this:

1. Using an x-api-key header (Recommended):

Curl

curl <endpoint_here> \
-X POST \
-H "x-api-key: <api_key_value>" \
-H "Content-Type: application/json" \

Python

from web3 import Web3
import requests

#define a http session with an api key
http_session = requests.Session()
http_session.update({'x-api-key': 'api_key_here'})

#defined the web3 provider
client = Web3.HTTPProvider('endpoint here')

JavaScript

import { Web3, HttpProvider } from 'web3';

// define web3 client
const client = new Web3(new HttpProvider('endpoint_here', {
    providerOptions: {
        headers: {
            "x-api-key": "api_key_value"
        }
    }
}));

1. Appending the API Key as a query parameter in the URL:

2. Appending the API Key as a query parameter in the URL:

Curl

curl "<endpoint_here>?apikey=<your-api-key>" \
-X POST \
-H "Content-Type: application/json" \

Python

from web3 import Web3
import requests

# Define the Web3 provider with API key in the URL
client = Web3(Web3.HTTPProvider('endpoint_here?apikey=api_key_here'))

JavaScript

import { Web3, HttpProvider } from 'web3';

// Define Web3 client with API key in the URL
const client = new Web3(new HttpProvider('endpoint_here?apikey=your-api-key'));