Quick Start Guide

Get started with OutScope in under 5 minutes.

1. Get Your API Key

Login to app.outscope.es and generate an API key from your account settings.

2. Create Your First Check

Using cURL

curl -X POST https://api.outscope.es/v1/check \
  -H "x-api-key: svc_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "fqdn": "example.com",
    "ports": [80, 443],
    "paths": ["/", "/api"]
  }'

Using Python SDK

from outscope_sdk import Client

# Initialize client
client = Client(api_key="svc_your_key_here")

# Create a check
check = client.checks.create(
    fqdn="example.com",
    ports=[80, 443],
    paths=["/", "/api"]
)

print(f"Check ID: {check['id']}")
print(f"Status: {check['status']}")

3. Get Results

# Wait for check to complete
import time
time.sleep(30)

# Get check results
result = client.checks.get(check['id'])

# Check if service is reachable
if result['analysis']['reachable']:
    print("✅ Service is externally accessible")
else:
    print("❌ Service is not reachable")

# Check service type
print(f"Service type: {result['analysis']['kind']}")

4. Analyze Results

The check provides comprehensive information:

• DNS Resolution - A/AAAA records and IP addresses
• TCP Connectivity - Which ports are open
• TLS Certificate - Validity and expiration
• HTTP Response - Status codes and headers
• Service Classification - API, HTML, documentation, etc.

What’s Next?

• Rate Limiting Guide
• API Reference
• Python SDK Documentation
• Best Practices

Need Help?

• Email: sales@outscope.es
• API Docs: api.outscope.es/docs