Skip to main content

​
Getting Your API Key

API keys allow you to programmatically interact with NativeBridge, enabling you to upload apps, generate magic links, and automate your testing workflows.
API keys are tied to your organization and have the same permissions as your user account. Keep them secure and never share them publicly.

​
Generate Your First API Key

Follow these simple steps to create your API key:
1

Navigate to Dashboard

Log in to your NativeBridge account and go to your Dashboard
2

Access API Keys Section

Click on “API Keys” in the sidebar navigation or go directly to API Keys
3

Create New API Key

Click the “Generate New API Key” button
4

Name Your Key

Give your API key a descriptive name (e.g., “GitHub Actions”, “Development”, “Production”)
5

Copy and Save

Copy your API key immediately - you won’t be able to see it again once you leave the page
Important: Your API key will only be shown once. Make sure to copy and store it securely before navigating away from the page.

​
Visual Guide

The API Keys section in your dashboard shows:
  • List of all active API keys
  • When each key was created
  • Last used timestamp
  • Options to revoke keys

​
Using Your API Key

Once you have your API key, you can use it in your API requests:

​
In HTTP Headers

curl -X POST https://api.nativebridge.dev/v1/apps/upload \
  -H "Authorization: Bearer YOUR_API_KEY_HERE" \
  -F "[email protected]" \
  -F "platform=android"

​
In Environment Variables

Store your API key as an environment variable for security: 
# .env file
NATIVEBRIDGE_API_KEY=your_api_key_here

// Node.js
const apiKey = process.env.NATIVEBRIDGE_API_KEY;

const response = await fetch('https://api.nativebridge.dev/v1/apps/upload', {
  headers: {
    'Authorization': `Bearer ${apiKey}`
  }
});

​
In CI/CD Pipelines

​
GitHub Actions

  1. Go to your repository Settings → Secrets → Actions
  2. Add a new secret named NATIVEBRIDGE_API_KEY
  3. Use in your workflow:
- name: Upload to NativeBridge
  run: |
    curl -X POST https://api.nativebridge.dev/v1/apps/upload \
      -H "Authorization: Bearer ${{ secrets.NATIVEBRIDGE_API_KEY }}" \
      -F "[email protected]"

​
GitLab CI

  1. Go to Project Settings → CI/CD → Variables
  2. Add a variable named NATIVEBRIDGE_API_KEY
  3. Use in your pipeline:
upload_app:
  script:
    - curl -X POST https://api.nativebridge.dev/v1/apps/upload \
        -H "Authorization: Bearer $NATIVEBRIDGE_API_KEY" \
        -F "[email protected]"

​
Managing API Keys

​
View All Keys

Your API Keys dashboard displays:
ColumnDescription
NameThe descriptive name you gave the key
CreatedWhen the key was generated
Last UsedMost recent API call using this key
ActionsRevoke or regenerate the key

​
Revoke a Key

To revoke an API key:
  1. Go to API Keys
  2. Find the key you want to revoke
  3. Click the “Revoke” button
  4. Confirm the action
Revoking a key immediately invalidates it. Any services using this key will lose access.

​
Regenerate a Key

If you suspect a key has been compromised:
  1. Revoke the compromised key immediately
  2. Generate a new key with the same name
  3. Update all services with the new key

​
Best Practices

​
Security Guidelines

​
DO ✅

  • Store keys in environment variables or secrets management systems
  • Use different keys for different environments
  • Revoke unused or compromised keys immediately
  • Monitor key usage in your dashboard
  • Use HTTPS for all API requests

​
DON’T ❌

  • Share keys in emails or chat messages
  • Commit keys to git repositories
  • Use the same key across multiple projects
  • Expose keys in client-side code
  • Log or print keys in console output

​
Rate Limits by Plan

API keys inherit the rate limits of your subscription plan:
PlanAPI Calls/HourConcurrent Requests
Free601
Starter3003
Growth100010
CustomUnlimitedUnlimited
Need higher limits? Contact us to discuss custom plans.

​
Troubleshooting

  • Ensure you’re including “Bearer ” before the key in the Authorization header
  • Check that the key hasn’t been revoked
  • Verify you’re using the correct API endpoint
  • Make sure there are no extra spaces or characters
  • Verify you have the necessary permissions in your organization
  • Check if your plan includes API access
  • Contact your organization admin for access
  • Once created, keys cannot be viewed again for security
  • You’ll need to revoke the old key and create a new one
  • Make sure to update all services with the new key
  • Check your current plan’s limits in the dashboard
  • Consider upgrading to a higher plan
  • Implement request caching and batching

​
Example: Your First API Call

Once you have your API key, try this simple test: 
# Test your API key
curl -X GET https://api.nativebridge.dev/v1/account \
  -H "Authorization: Bearer YOUR_API_KEY_HERE"

# Expected response:
{
  "organization": "Your Organization",
  "plan": "starter",
  "api_calls_remaining": 298
}

​
Next Steps

API Reference

Explore all available API endpoints

Upload Your First App

Start uploading apps via API

CI/CD Integration

Automate with GitHub Actions & GitLab

Postman Collection

Interactive API documentation