API Documentation

Programmatically access and manage your NerdRules data

API Overview

Introduction to the NerdRules API

The NerdRules API provides programmatic access to your rules, allowing you to integrate NerdRules with your existing tools and workflows. With the API, you can:

  • Retrieve rules and rule versions
  • Create and update rules
  • Manage tags and categories
  • Access user profile information
  • Automate rule management workflows

Base URL

All API requests should be made to the following base URL:

https://api.nerdrules.com/v1

Response Format

All API responses are returned in JSON format. A typical response looks like this:

{
  "data": {
    // Response data here
  },
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 42
  }
}

Error Handling

When an error occurs, the API will return an appropriate HTTP status code and a JSON response with error details:

{
  "error": {
    "code": "invalid_request",
    "message": "The request was invalid",
    "details": "The 'name' field is required"
  }
}

Need Help?

If you have questions or need assistance with the API, please check our documentation or contact our support team.