Parseable Docs

API Reference

GitHubView on GitHub

This section provides detailed information about the available API endpoints for interacting with Parseable.

Getting Started

Before you begin, make sure you have:

  • A running instance of Parseable
  • The base URL of your Parseable server
  • Required authentication credentials (if authentication is enabled)

API Endpoints

Create log stream

Create a new log stream with the specified name and configuration.

Send logs to a stream

Send logs to an existing log stream.

Delete log stream

Delete an existing log stream and all its associated data.

Ingest logs with headers

Send log data to a specific log stream using HTTP headers.

Query API

Query data from log streams using SQL.

Authentication

All API requests require authentication. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Rate Limiting

API requests are subject to rate limiting. The default rate limit is 100 requests per minute per IP address.

Error Handling

All error responses follow a standard format:

{
  "error": {
    "code": "error_code",
    "message": "Human-readable error message"
  }
}

Need Help?

If you have any questions or run into issues, please refer to our GitHub repository or join our community.

On this page