API Overview

API Overview

The NEURO API provides programmatic access to your security assessment data. Build integrations, automate workflows, and connect NEURO with your existing tools.

Base URL

All API requests use your tenant-specific domain:

https://{tenant}.nforged.com/api/v1

Replace {tenant} with your organization’s subdomain (e.g., acme.nforged.com).

Authentication

All API requests require authentication using Bearer tokens:

curl -X GET "https://{tenant}.nforged.com/api/v1/projects" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

See Authentication for details on obtaining tokens.

Request Format

Headers

Required headers:

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request Body

POST and PUT requests use JSON:

{
  "name": "Project Name",
  "client_id": "client_123"
}

Response Format

Success Response

{
  "success": true,
  "data": {
    "id": "proj_123",
    "name": "Project Name"
  }
}

List Response

{
  "success": true,
  "data": [...],
  "meta": {
    "page": 1,
    "limit": 50,
    "total": 234,
    "pages": 5
  }
}

Error Response

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid input",
    "details": [
      {"field": "name", "message": "Name is required"}
    ]
  }
}

HTTP Status Codes

Code	Description
200	Success
201	Created
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
429	Rate Limited
500	Server Error

Rate Limiting

Limit	Value
Requests per minute	1,000
Requests per hour	10,000

Rate limit headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640000000

Pagination

List endpoints support pagination:

GET /findings?page=2&limit=50

Parameter	Default	Maximum
page	1	-
limit	50	100

Filtering

Filter results with query parameters:

GET /findings?severity=High&status=Open&project_id=proj_123

Common filters:

• severity - Critical, High, Medium, Low, Info
• status - Open, Confirmed, Remediated
• project_id - Filter by project
• created_after - ISO date
• created_before - ISO date
• search - Text search

Sorting

Sort results:

GET /findings?sort=created_at&order=desc

API Endpoints

Core Resources

Resource	Base Path
Projects	/projects
Findings	/findings
Assets	/assets
Reports	/reports
Clients	/clients
Users	/users

Operations

Method	Description
GET	Retrieve resources
POST	Create resources
PUT	Update resources
DELETE	Delete resources

SDKs & Libraries

Official SDKs

Coming soon:

• Python SDK
• JavaScript/Node.js SDK
• Go SDK

Community Libraries

Check our GitHub for community-contributed libraries.

Webhooks

Receive real-time notifications:

• finding.created
• finding.updated
• project.created
• report.generated

Configure in Settings → Webhooks.

Getting Started

1. Generate an API token
2. Make your first request
3. Explore the endpoint documentation
4. Build your integration

Support

• API questions: api-support@nforged.com
• Documentation issues: docs@nforged.com
• Status page: status.nforged.com

---

Next: Learn about API Authentication