Get your API keys

Get your API Key

To retrieve your API key, follow these steps:

1. Navigate to the official UpRock website.
2. Sign in with your email, and you will be sent a six-digit code to confirm your account
3. Input the six-digit code in the provided input fields, and you will be redirected to your dashboard
4. Navigate to the API section
5. Click the button labeled Create new key
6. Create a name for your API key.
7. Click Create key and your API will be generated within a few seconds.
8. Copy your API key immediately and store it safely.
9. Select the required permissions. For basic operations, make sure the crawl:read permission is enabled.

Store and Configure Your Credentials

To keep your API key secure, store it in environment variables rather than hardcoding it in your application code.

There are two ways to store your API keys, choose the method that suits your development process.

Method 1: Using a .env File

This method is suitable for local development purposes and it's recommended if you are just getting started.

1. Create a .env file in your project's root directory.

   UPROCK_API_KEY=your-api-key-here
   # Optional — defaults to https://edge.uprock.com
   UPROCK_BASE_URL=https://edge.uprock.com

2. Add .env to your .gitignore to prevent committing your API key to version control.

   .env
   .env.local
   *.env

3. On macOS or Linux, run the following command in your terminal from the project root to restrict access to the .env file:

   chmod 600 .env

Method 2: Using System Environment Variables

This method is recommended for production and CI/CD environments, where the same system is used by multiple users or services.

# Add to ~/.bashrc or ~/.bash_profile
echo 'export UPROCK_API_KEY="your-api-key-here"' >> ~/.bashrc
source ~/.bashrc  # Reload configuration

# Add to ~/.zshrc
echo 'export UPROCK_API_KEY="your-api-key-here"' >> ~/.zshrc
source ~/.zshrc  # Reload configuration

set -Ux UPROCK_API_KEY "your-api-key-here"

# Set for all future sessions
[System.Environment]::SetEnvironmentVariable('UPROCK_API_KEY','your-api-key-here','User')

# Set for current session only

$env:UPROCK_API_KEY = "your-api-key-here"

setx UPROCK_API_KEY "your-api-key-here"

Corporate Proxy Configuration

If you're working behind a corporate proxy, configure these additional environment variables into your system:

export HTTPS_PROXY="https://user:pass@proxy.example.com:8443"
export NO_PROXY="localhost,127.0.0.1"

$env:HTTPS_PROXY = "https://user:pass@proxy.example.com:8443"
$env:NO_PROXY = "localhost,127.0.0.1"

Verify your API key and connectivity

Now that you have generated and configured your API key, verify with a simple health check request, that it is set up correctly and that your system can successfully authenticate with the UpRock API.

curl -X POST https://edge.uprock.com/crawl/v1/new 
-H "Authorization: Bearer <API KEY> " 
-H "Content-Type: application/json"
-d '{"url": "https://example.com"}'

$headers = @{ 
    Authorization = "Bearer <API KEY>"
    "Content-Type" = "application/json"
}
$body = '{"url": "https://example.com"}'
$response = Invoke-WebRequest -Method POST -Headers $headers -Body $body -Uri "https://edge.uprock.com/crawl/v1/new"
$response.Content

Expected Output

{
  "job_id": "f2bf9f8b-10ee-4c61-9633-4eacc3XXXac8",
  "url": "https://example.com",
  "method": "GET",
  "status": "pending",
  "submitted_at": "2026-02-17T18:00:00Z",
  "timeout_sec": 30
}