### GET /api/backends/{token} Source: https://logflare.app/api/openapi API endpoint for GET /api/backends/{token} ```markdown ### Parameters - **token** (string, path, required): Backend token ### Responses #### 200 - BackendApiSchema Response **BackendApiSchema** - **config** (object) - **default_ingest?** (boolean) - **id** (integer) - **inserted_at** (string (date-time)) - **metadata** (object) - **name** (string) (required) - **token** (string) - **updated_at** (string (date-time)) #### 404 - Not found - **error** (string) (required) ### Example Usage ```bash curl -X GET "https://logflare.app/api/backends/{token}" ``` ``` -------------------------------- ### GET /api/backends Source: https://logflare.app/api/openapi API endpoint for GET /api/backends ```markdown ### Responses #### 200 - BackendApiSchema List Response - Array of object - **config** (object) - **default_ingest?** (boolean) - **id** (integer) - **inserted_at** (string (date-time)) - **metadata** (object) - **name** (string) (required) - **token** (string) - **updated_at** (string (date-time)) ### Example Usage ```bash curl -X GET "https://logflare.app/api/backends" ``` ``` -------------------------------- ### GET /api/sources/{token} Source: https://logflare.app/api/openapi API endpoint for GET /api/sources/{token} ```markdown ### Parameters - **token** (string, path, required): Source Token ### Responses #### 200 - Source Response **Source** - **api_quota** (integer) - **bigquery_table_ttl** (integer) - **bq_table_id** (string) - **custom_event_message_keys** (string) - **default_ingest_backend_enabled?** (boolean) - **favorite** (boolean) - **has_rejected_events** (boolean) - **id** (integer) - **inserted_at** (string (date-time)) - **metrics** (object) - **name** (string) (required) - **notifications** (object) - **public_token** (string) - **slack_hook_url** (string) - **token** (string) - **updated_at** (string (date-time)) - **webhook_notification_url** (string) #### 404 - Not found - **error** (string) (required) ### Example Usage ```bash curl -X GET "https://logflare.app/api/sources/{token}" ``` ``` -------------------------------- ### GET /api/sources Source: https://logflare.app/api/openapi API endpoint for GET /api/sources ```markdown ### Responses #### 200 - Source List Response - Array of object - **api_quota** (integer) - **bigquery_table_ttl** (integer) - **bq_table_id** (string) - **custom_event_message_keys** (string) - **default_ingest_backend_enabled?** (boolean) - **favorite** (boolean) - **has_rejected_events** (boolean) - **id** (integer) - **inserted_at** (string (date-time)) - **metrics** (object) - **name** (string) (required) - **notifications** (object) - **public_token** (string) - **slack_hook_url** (string) - **token** (string) - **updated_at** (string (date-time)) - **webhook_notification_url** (string) ### Example Usage ```bash curl -X GET "https://logflare.app/api/sources" ``` ``` -------------------------------- ### GET /api/sources/{source_token}/schema Source: https://logflare.app/api/openapi API endpoint for GET /api/sources/{source_token}/schema ```markdown ### Parameters - **source_token** (string, path, required): Source Token ### Responses #### 200 - SourceSchema Response **SourceSchema** #### 404 - Not found - **error** (string) (required) ### Example Usage ```bash curl -X GET "https://logflare.app/api/sources/{source_token}/schema" ``` ``` -------------------------------- ### GET /api/rules Source: https://logflare.app/api/openapi API endpoint for GET /api/rules ```markdown ### Responses #### 200 - RuleApiSchema List Response - Array of object - **backend_id** (integer) - **id** (integer) - **inserted_at** (string (date-time)) - **lql_string** (string) - **source_id** (integer) - **token** (string) - **updated_at** (string (date-time)) ### Example Usage ```bash curl -X GET "https://logflare.app/api/rules" ``` ``` -------------------------------- ### GET /api/query Source: https://logflare.app/api/openapi API endpoint for GET /api/query ```markdown ### Parameters - **sql** (string, query, optional): BigQuery SQL string, alias for bq_sql - **bq_sql** (string, query, optional): BigQuery SQL string - **ch_sql** (string, query, optional): ClickHouse SQL string - **pg_sql** (string, query, optional): PostgresSQL string ### Responses #### 200 - QueryResult List Response - Array of object - **errors** (object) - **result** (object) (required) ### Example Usage ```bash curl -X GET "https://logflare.app/api/query?sql=string&bq_sql=string&ch_sql=string&pg_sql=string" ``` ``` -------------------------------- ### GET /api/query/parse Source: https://logflare.app/api/openapi API endpoint for GET /api/query/parse ```markdown ### Parameters - **sql** (string, query, optional): BigQuery SQL string, alias for bq_sql - **bq_sql** (string, query, optional): BigQuery SQL string - **ch_sql** (string, query, optional): ClickHouse SQL string ### Responses #### 200 - QueryParseResult One Response **QueryParseResult** - **errors** (object) - **result** (object) (required) #### 400 - Bad request **BadRequest** ### Example Usage ```bash curl -X GET "https://logflare.app/api/query/parse?sql=string&bq_sql=string&ch_sql=string" ``` ``` -------------------------------- ### GET /api/rules/{token} Source: https://logflare.app/api/openapi API endpoint for GET /api/rules/{token} ```markdown ### Parameters - **token** (string, path, required): Rule UUID ### Responses #### 200 - RuleApiSchema Response **RuleApiSchema** - **backend_id** (integer) - **id** (integer) - **inserted_at** (string (date-time)) - **lql_string** (string) - **source_id** (integer) - **token** (string) - **updated_at** (string (date-time)) #### 404 - Not found - **error** (string) (required) ### Example Usage ```bash curl -X GET "https://logflare.app/api/rules/{token}" ``` ``` -------------------------------- ### GET /api/sources/{source_token}/recent Source: https://logflare.app/api/openapi API endpoint for GET /api/sources/{source_token}/recent ```markdown ### Parameters - **source_token** (string, path, required): Source Token ### Responses #### 200 - Event List Response - Array of object - **event_message** (string) - **timestamp** (integer) #### 404 - Not found - **error** (string) (required) ### Example Usage ```bash curl -X GET "https://logflare.app/api/sources/{source_token}/recent" ``` ``` -------------------------------- ### GET /api/access-tokens Source: https://logflare.app/api/openapi API endpoint for GET /api/access-tokens ```markdown ### Responses #### 200 - AccessToken List Response - Array of object - **description** (string) - **id** (integer) - **inserted_at** (string (date-time)) - **scopes** (string) - **token** (string) ### Example Usage ```bash curl -X GET "https://logflare.app/api/access-tokens" ``` ``` -------------------------------- ### GET /api/endpoints/{token} Source: https://logflare.app/api/openapi API endpoint for GET /api/endpoints/{token} ```markdown ### Parameters - **token** (string, path, required): Endpoint UUID Token ### Responses #### 200 - EndpointApiSchema Response **EndpointApiSchema** - **cache_duration_seconds** (integer) - **description** (string) - **enable_auth** (boolean) - **id** (integer) - **max_limit** (integer) - **name** (string) (required) - **proactive_requerying_seconds** (integer) - **query** (string) (required) - **sandboxable** (boolean) - **source_mapping** (object) - **token** (string) #### 404 - Not found - **error** (string) (required) ### Example Usage ```bash curl -X GET "https://logflare.app/api/endpoints/{token}" ``` ``` -------------------------------- ### GET /api/endpoints/query/{token_or_name} Source: https://logflare.app/api/openapi Full details are available in the [Logflare Endpoints documentation](https://docs.logflare.app/concepts/endpoints/) ```markdown ### Parameters - **token_or_name** (string, path, required): Endpoint UUID or name ### Responses #### 200 - EndpointQuery Response **EndpointQuery** - **error** (object) - **result** (array (object)) #### 401 - Unauthorized **Unauthorized** #### 500 - Server error **ServerError** ### Example Usage ```bash curl -X GET "https://logflare.app/api/endpoints/query/{token_or_name}" ``` ``` -------------------------------- ### GET /api/endpoints Source: https://logflare.app/api/openapi API endpoint for GET /api/endpoints ```markdown ### Responses #### 200 - EndpointApiSchema List Response - Array of object - **cache_duration_seconds** (integer) - **description** (string) - **enable_auth** (boolean) - **id** (integer) - **max_limit** (integer) - **name** (string) (required) - **proactive_requerying_seconds** (integer) - **query** (string) (required) - **sandboxable** (boolean) - **source_mapping** (object) - **token** (string) ### Example Usage ```bash curl -X GET "https://logflare.app/api/endpoints" ``` ``` -------------------------------- ### GET /api/teams/{token} Source: https://logflare.app/api/openapi API endpoint for GET /api/teams/{token} ```markdown ### Parameters - **token** (string, path, required): Team Token ### Responses #### 200 - Team Response **Team** - **name** (string) (required) - **team_users** (array (object)) Array items: - **email** (string) (required) - **name** (string) (required) - **token** (string) - **user** (object) - **api_key** (string) (required) - **api_quota** (integer) - **bigquery_dataset_id** (string) - **bigquery_dataset_location** (string) - **bigquery_project_id** (string) - **company** (string) - **email** (string) (required) - **email_me_product** (boolean) - **email_preferred** (string) - **image** (string) - **name** (string) - **phone** (string) - **provider** (string) (required) - **token** (string) (required) #### 404 - Not found - **error** (string) (required) ### Example Usage ```bash curl -X GET "https://logflare.app/api/teams/{token}" ``` ``` -------------------------------- ### GET /api/endpoints/query/name/{name} Source: https://logflare.app/api/openapi Full details are available in the [Logflare Endpoints documentation](https://docs.logflare.app/concepts/endpoints/) ```markdown ### Parameters - **token_or_name** (string, path, required): Endpoint UUID or name ### Responses #### 200 - EndpointQuery Response **EndpointQuery** - **error** (object) - **result** (array (object)) #### 401 - Unauthorized **Unauthorized** #### 500 - Server error **ServerError** ### Example Usage ```bash curl -X GET "https://logflare.app/api/endpoints/query/name/{name}" ``` ``` -------------------------------- ### GET /api/teams Source: https://logflare.app/api/openapi API endpoint for GET /api/teams ```markdown ### Responses #### 200 - Team List Response - Array of object - **name** (string) (required) - **team_users** (array (object)) Array items: - **email** (string) (required) - **name** (string) (required) - **token** (string) - **user** (object) - **api_key** (string) (required) - **api_quota** (integer) - **bigquery_dataset_id** (string) - **bigquery_dataset_location** (string) - **bigquery_project_id** (string) - **company** (string) - **email** (string) (required) - **email_me_product** (boolean) - **email_preferred** (string) - **image** (string) - **name** (string) - **phone** (string) - **provider** (string) (required) - **token** (string) (required) ### Example Usage ```bash curl -X GET "https://logflare.app/api/teams" ``` ``` -------------------------------- ### POST /api/sources/{source_token}/backends/{backend_token} Source: https://logflare.app/api/openapi API endpoint for POST /api/sources/{source_token}/backends/{backend_token} ```markdown ### Parameters - **source_token** (string, path, required): Source Token - **backend_token** (string, path, required): Backend Token ### Responses #### 201 - Source Response **Source** - **api_quota** (integer) - **bigquery_table_ttl** (integer) - **bq_table_id** (string) - **custom_event_message_keys** (string) - **default_ingest_backend_enabled?** (boolean) - **favorite** (boolean) - **has_rejected_events** (boolean) - **id** (integer) - **inserted_at** (string (date-time)) - **metrics** (object) - **name** (string) (required) - **notifications** (object) - **public_token** (string) - **slack_hook_url** (string) - **token** (string) - **updated_at** (string (date-time)) - **webhook_notification_url** (string) #### 404 - Not found - **error** (string) (required) ### Example Usage ```bash curl -X POST "https://logflare.app/api/sources/{source_token}/backends/{backend_token}" ``` ``` -------------------------------- ### PUT /api/sources/{token} Source: https://logflare.app/api/openapi API endpoint for PUT /api/sources/{token} ```markdown ### Parameters - **token** (string, path, required): Source Token ### Request Body **Content-Type:** application/json - **api_quota** (integer) - **bigquery_table_ttl** (integer) - **bq_table_id** (string) - **custom_event_message_keys** (string) - **default_ingest_backend_enabled?** (boolean) - **favorite** (boolean) - **has_rejected_events** (boolean) - **id** (integer) - **inserted_at** (string (date-time)) - **metrics** (object) - **name** (string) (required) - **notifications** (object) - **public_token** (string) - **slack_hook_url** (string) - **token** (string) - **updated_at** (string (date-time)) - **webhook_notification_url** (string) ### Responses #### 200 - Accepted Response #### 204 - Accepted Response #### 404 - Not found - **error** (string) (required) ### Example Usage ```bash curl -X PUT "https://logflare.app/api/sources/{token}" \ -H "Content-Type: application/json" \ -d '{ "api_quota": "0", "bigquery_table_ttl": "0", "bq_table_id": "string", "custom_event_message_keys": "string", "default_ingest_backend_enabled?": "true", "favorite": "true", "has_rejected_events": "true", "id": "0", "inserted_at": "2023-01-01T00:00:00Z", "metrics": "value", "name": "string", "notifications": "value", "public_token": "string", "slack_hook_url": "string", "token": "string", "updated_at": "2023-01-01T00:00:00Z", "webhook_notification_url": "string" }' ``` ``` -------------------------------- ### PUT /api/backends/{token} Source: https://logflare.app/api/openapi API endpoint for PUT /api/backends/{token} ```markdown ### Parameters - **token** (string, path, required): Backend Token ### Request Body **Content-Type:** application/json - **config** (object) - **default_ingest?** (boolean) - **id** (integer) - **inserted_at** (string (date-time)) - **metadata** (object) - **name** (string) (required) - **token** (string) - **updated_at** (string (date-time)) ### Responses #### 200 - Accepted Response **BackendApiSchema** - **config** (object) - **default_ingest?** (boolean) - **id** (integer) - **inserted_at** (string (date-time)) - **metadata** (object) - **name** (string) (required) - **token** (string) - **updated_at** (string (date-time)) #### 204 - Accepted Response #### 404 - Not found - **error** (string) (required) ### Example Usage ```bash curl -X PUT "https://logflare.app/api/backends/{token}" \ -H "Content-Type: application/json" \ -d '{ "config": "value", "default_ingest?": "true", "id": "0", "inserted_at": "2023-01-01T00:00:00Z", "metadata": "value", "name": "string", "token": "string", "updated_at": "2023-01-01T00:00:00Z" }' ``` ``` -------------------------------- ### API Overview: logflare Source: https://logflare.app/api/openapi OpenAPI specification version 1.24.0 ```yaml # logflare # Version: 1.24.0 OpenAPI specification # Base URL: https://logflare.app ``` -------------------------------- ### OPTIONS /api/events Source: https://logflare.app/api/openapi Full details are available in the [ingestion documentation](https://docs.logflare.app/concepts/ingestion/) ```markdown ### Parameters - **source** (string, query, optional): Source UUID - **source_name** (string, query, optional): Source name ### Responses #### 200 - Created Response **LogsCreated** - **message** (string) (example: "Logged!") #### 500 - Server error **ServerError** ### Example Usage ```bash curl -X OPTIONS "https://logflare.app/api/events?source=string&source_name=string" ``` ``` -------------------------------- ### OPTIONS /api/logs Source: https://logflare.app/api/openapi Full details are available in the [ingestion documentation](https://docs.logflare.app/concepts/ingestion/) ```markdown ### Parameters - **source** (string, query, optional): Source UUID - **source_name** (string, query, optional): Source name ### Responses #### 200 - Created Response **LogsCreated** - **message** (string) (example: "Logged!") #### 500 - Server error **ServerError** ### Example Usage ```bash curl -X OPTIONS "https://logflare.app/api/logs?source=string&source_name=string" ``` ``` -------------------------------- ### POST /api/sources Source: https://logflare.app/api/openapi API endpoint for POST /api/sources ```markdown ### Request Body **Content-Type:** application/json - **api_quota** (integer) - **bigquery_table_ttl** (integer) - **bq_table_id** (string) - **custom_event_message_keys** (string) - **default_ingest_backend_enabled?** (boolean) - **favorite** (boolean) - **has_rejected_events** (boolean) - **id** (integer) - **inserted_at** (string (date-time)) - **metrics** (object) - **name** (string) (required) - **notifications** (object) - **public_token** (string) - **slack_hook_url** (string) - **token** (string) - **updated_at** (string (date-time)) - **webhook_notification_url** (string) ### Responses #### 201 - Created Response **Source** - **api_quota** (integer) - **bigquery_table_ttl** (integer) - **bq_table_id** (string) - **custom_event_message_keys** (string) - **default_ingest_backend_enabled?** (boolean) - **favorite** (boolean) - **has_rejected_events** (boolean) - **id** (integer) - **inserted_at** (string (date-time)) - **metrics** (object) - **name** (string) (required) - **notifications** (object) - **public_token** (string) - **slack_hook_url** (string) - **token** (string) - **updated_at** (string (date-time)) - **webhook_notification_url** (string) #### 404 - Not found - **error** (string) (required) ### Example Usage ```bash curl -X POST "https://logflare.app/api/sources" \ -H "Content-Type: application/json" \ -d '{ "api_quota": "0", "bigquery_table_ttl": "0", "bq_table_id": "string", "custom_event_message_keys": "string", "default_ingest_backend_enabled?": "true", "favorite": "true", "has_rejected_events": "true", "id": "0", "inserted_at": "2023-01-01T00:00:00Z", "metrics": "value", "name": "string", "notifications": "value", "public_token": "string", "slack_hook_url": "string", "token": "string", "updated_at": "2023-01-01T00:00:00Z", "webhook_notification_url": "string" }' ``` ``` -------------------------------- ### POST /api/backends Source: https://logflare.app/api/openapi API endpoint for POST /api/backends ```markdown ### Request Body **Content-Type:** application/json - **config** (object) - **default_ingest?** (boolean) - **id** (integer) - **inserted_at** (string (date-time)) - **metadata** (object) - **name** (string) (required) - **token** (string) - **updated_at** (string (date-time)) ### Responses #### 201 - Created Response **BackendApiSchema** - **config** (object) - **default_ingest?** (boolean) - **id** (integer) - **inserted_at** (string (date-time)) - **metadata** (object) - **name** (string) (required) - **token** (string) - **updated_at** (string (date-time)) #### 404 - Not found - **error** (string) (required) ### Example Usage ```bash curl -X POST "https://logflare.app/api/backends" \ -H "Content-Type: application/json" \ -d '{ "config": "value", "default_ingest?": "true", "id": "0", "inserted_at": "2023-01-01T00:00:00Z", "metadata": "value", "name": "string", "token": "string", "updated_at": "2023-01-01T00:00:00Z" }' ``` ``` -------------------------------- ### POST /api/logs Source: https://logflare.app/api/openapi Full details are available in the [ingestion documentation](https://docs.logflare.app/concepts/ingestion/) ```markdown ### Parameters - **source** (string, query, optional): Source UUID - **source_name** (string, query, optional): Source name ### Responses #### 200 - Created Response **LogsCreated** - **message** (string) (example: "Logged!") #### 500 - Server error **ServerError** ### Example Usage ```bash curl -X POST "https://logflare.app/api/logs?source=string&source_name=string" ``` ``` -------------------------------- ### PATCH /api/sources/{token} Source: https://logflare.app/api/openapi API endpoint for PATCH /api/sources/{token} ```markdown ### Parameters - **token** (string, path, required): Source Token ### Request Body **Content-Type:** application/json - **api_quota** (integer) - **bigquery_table_ttl** (integer) - **bq_table_id** (string) - **custom_event_message_keys** (string) - **default_ingest_backend_enabled?** (boolean) - **favorite** (boolean) - **has_rejected_events** (boolean) - **id** (integer) - **inserted_at** (string (date-time)) - **metrics** (object) - **name** (string) (required) - **notifications** (object) - **public_token** (string) - **slack_hook_url** (string) - **token** (string) - **updated_at** (string (date-time)) - **webhook_notification_url** (string) ### Responses #### 200 - Accepted Response #### 204 - Accepted Response #### 404 - Not found - **error** (string) (required) ### Example Usage ```bash curl -X PATCH "https://logflare.app/api/sources/{token}" \ -H "Content-Type: application/json" \ -d '{ "api_quota": "0", "bigquery_table_ttl": "0", "bq_table_id": "string", "custom_event_message_keys": "string", "default_ingest_backend_enabled?": "true", "favorite": "true", "has_rejected_events": "true", "id": "0", "inserted_at": "2023-01-01T00:00:00Z", "metrics": "value", "name": "string", "notifications": "value", "public_token": "string", "slack_hook_url": "string", "token": "string", "updated_at": "2023-01-01T00:00:00Z", "webhook_notification_url": "string" }' ``` ``` -------------------------------- ### POST /api/events Source: https://logflare.app/api/openapi Full details are available in the [ingestion documentation](https://docs.logflare.app/concepts/ingestion/) ```markdown ### Parameters - **source** (string, query, optional): Source UUID - **source_name** (string, query, optional): Source name ### Responses #### 200 - Created Response **LogsCreated** - **message** (string) (example: "Logged!") #### 500 - Server error **ServerError** ### Example Usage ```bash curl -X POST "https://logflare.app/api/events?source=string&source_name=string" ``` ``` -------------------------------- ### PATCH /api/backends/{token} Source: https://logflare.app/api/openapi API endpoint for PATCH /api/backends/{token} ```markdown ### Parameters - **token** (string, path, required): Backend Token ### Request Body **Content-Type:** application/json - **config** (object) - **default_ingest?** (boolean) - **id** (integer) - **inserted_at** (string (date-time)) - **metadata** (object) - **name** (string) (required) - **token** (string) - **updated_at** (string (date-time)) ### Responses #### 200 - Accepted Response **BackendApiSchema** - **config** (object) - **default_ingest?** (boolean) - **id** (integer) - **inserted_at** (string (date-time)) - **metadata** (object) - **name** (string) (required) - **token** (string) - **updated_at** (string (date-time)) #### 204 - Accepted Response #### 404 - Not found - **error** (string) (required) ### Example Usage ```bash curl -X PATCH "https://logflare.app/api/backends/{token}" \ -H "Content-Type: application/json" \ -d '{ "config": "value", "default_ingest?": "true", "id": "0", "inserted_at": "2023-01-01T00:00:00Z", "metadata": "value", "name": "string", "token": "string", "updated_at": "2023-01-01T00:00:00Z" }' ``` ``` -------------------------------- ### POST /api/endpoints/query/{token_or_name} Source: https://logflare.app/api/openapi Full details are available in the [Logflare Endpoints documentation](https://docs.logflare.app/concepts/endpoints/) ```markdown ### Parameters - **token_or_name** (string, path, required): Endpoint UUID or name ### Responses #### 200 - EndpointQuery Response **EndpointQuery** - **error** (object) - **result** (array (object)) #### 401 - Unauthorized **Unauthorized** #### 500 - Server error **ServerError** ### Example Usage ```bash curl -X POST "https://logflare.app/api/endpoints/query/{token_or_name}" ``` ``` -------------------------------- ### PUT /api/rules/{token} Source: https://logflare.app/api/openapi API endpoint for PUT /api/rules/{token} ```markdown ### Parameters - **token** (string, path, required): Rule UUID ### Request Body **Content-Type:** application/json - **backend_id** (integer) - **id** (integer) - **inserted_at** (string (date-time)) - **lql_string** (string) - **source_id** (integer) - **token** (string) - **updated_at** (string (date-time)) ### Responses #### 200 - Accepted Response **RuleApiSchema** - **backend_id** (integer) - **id** (integer) - **inserted_at** (string (date-time)) - **lql_string** (string) - **source_id** (integer) - **token** (string) - **updated_at** (string (date-time)) #### 204 - Accepted Response #### 404 - Not found - **error** (string) (required) ### Example Usage ```bash curl -X PUT "https://logflare.app/api/rules/{token}" \ -H "Content-Type: application/json" \ -d '{ "backend_id": "0", "id": "0", "inserted_at": "2023-01-01T00:00:00Z", "lql_string": "string", "source_id": "0", "token": "string", "updated_at": "2023-01-01T00:00:00Z" }' ``` ``` -------------------------------- ### PATCH /api/rules/{token} Source: https://logflare.app/api/openapi API endpoint for PATCH /api/rules/{token} ```markdown ### Parameters - **token** (string, path, required): Rule UUID ### Request Body **Content-Type:** application/json - **backend_id** (integer) - **id** (integer) - **inserted_at** (string (date-time)) - **lql_string** (string) - **source_id** (integer) - **token** (string) - **updated_at** (string (date-time)) ### Responses #### 200 - Accepted Response **RuleApiSchema** - **backend_id** (integer) - **id** (integer) - **inserted_at** (string (date-time)) - **lql_string** (string) - **source_id** (integer) - **token** (string) - **updated_at** (string (date-time)) #### 204 - Accepted Response #### 404 - Not found - **error** (string) (required) ### Example Usage ```bash curl -X PATCH "https://logflare.app/api/rules/{token}" \ -H "Content-Type: application/json" \ -d '{ "backend_id": "0", "id": "0", "inserted_at": "2023-01-01T00:00:00Z", "lql_string": "string", "source_id": "0", "token": "string", "updated_at": "2023-01-01T00:00:00Z" }' ``` ``` -------------------------------- ### Schema: Source Source: https://logflare.app/api/openapi Schema definition for Source ```markdown ## Schema: Source Schema definition for Source **Type:** object - **api_quota** (integer) - **bigquery_table_ttl** (integer) - **bq_table_id** (string) - **custom_event_message_keys** (string) - **default_ingest_backend_enabled?** (boolean) - **favorite** (boolean) - **has_rejected_events** (boolean) - **id** (integer) - **inserted_at** (string (date-time)) - **metrics** (object) - **name** (string) (required) - **notifications** (object) - **public_token** (string) - **slack_hook_url** (string) - **token** (string) - **updated_at** (string (date-time)) - **webhook_notification_url** (string) ``` -------------------------------- ### Schema: User Source: https://logflare.app/api/openapi Schema definition for User ```markdown ## Schema: User Schema definition for User **Type:** object - **api_key** (string) (required) - **api_quota** (integer) - **bigquery_dataset_id** (string) - **bigquery_dataset_location** (string) - **bigquery_project_id** (string) - **company** (string) - **email** (string) (required) - **email_me_product** (boolean) - **email_preferred** (string) - **image** (string) - **name** (string) - **phone** (string) - **provider** (string) (required) - **token** (string) (required) ``` -------------------------------- ### POST /api/access-tokens Source: https://logflare.app/api/openapi API endpoint for POST /api/access-tokens ```markdown ### Request Body **Content-Type:** application/json - **description** (string) - **id** (integer) - **inserted_at** (string (date-time)) - **scopes** (string) - **token** (string) ### Responses #### 201 - Created Response **AccessToken** - **description** (string) - **id** (integer) - **inserted_at** (string (date-time)) - **scopes** (string) - **token** (string) #### 401 - Unauthorized **Unauthorized** #### 404 - Not found - **error** (string) (required) ### Example Usage ```bash curl -X POST "https://logflare.app/api/access-tokens" \ -H "Content-Type: application/json" \ -d '{ "description": "string", "id": "0", "inserted_at": "2023-01-01T00:00:00Z", "scopes": "string", "token": "string" }' ``` ``` -------------------------------- ### PUT /api/endpoints/{token} Source: https://logflare.app/api/openapi API endpoint for PUT /api/endpoints/{token} ```markdown ### Parameters - **token** (string, path, required): Endpoint UUID Token ### Request Body **Content-Type:** application/json - **cache_duration_seconds** (integer) - **description** (string) - **enable_auth** (boolean) - **id** (integer) - **max_limit** (integer) - **name** (string) (required) - **proactive_requerying_seconds** (integer) - **query** (string) (required) - **sandboxable** (boolean) - **source_mapping** (object) - **token** (string) ### Responses #### 200 - Accepted Response **EndpointApiSchema** - **cache_duration_seconds** (integer) - **description** (string) - **enable_auth** (boolean) - **id** (integer) - **max_limit** (integer) - **name** (string) (required) - **proactive_requerying_seconds** (integer) - **query** (string) (required) - **sandboxable** (boolean) - **source_mapping** (object) - **token** (string) #### 204 - Accepted Response #### 404 - Not found - **error** (string) (required) #### 422 - Unprocessable Entity - **errors** (object) (required) ### Example Usage ```bash curl -X PUT "https://logflare.app/api/endpoints/{token}" \ -H "Content-Type: application/json" \ -d '{ "cache_duration_seconds": "0", "description": "string", "enable_auth": "true", "id": "0", "max_limit": "0", "name": "string", "proactive_requerying_seconds": "0", "query": "string", "sandboxable": "true", "source_mapping": "value", "token": "string" }' ``` ``` -------------------------------- ### PUT /api/teams/{token} Source: https://logflare.app/api/openapi API endpoint for PUT /api/teams/{token} ```markdown ### Parameters - **token** (string, path, required): Team Token ### Request Body **Content-Type:** application/json - **name** (string) (required) - **team_users** (array (object)) Array items: - **email** (string) (required) - **name** (string) (required) - **token** (string) - **user** (object) - **api_key** (string) (required) - **api_quota** (integer) - **bigquery_dataset_id** (string) - **bigquery_dataset_location** (string) - **bigquery_project_id** (string) - **company** (string) - **email** (string) (required) - **email_me_product** (boolean) - **email_preferred** (string) - **image** (string) - **name** (string) - **phone** (string) - **provider** (string) (required) - **token** (string) (required) ### Responses #### 201 - Created Response **Team** - **name** (string) (required) - **team_users** (array (object)) Array items: - **email** (string) (required) - **name** (string) (required) - **token** (string) - **user** (object) - **api_key** (string) (required) - **api_quota** (integer) - **bigquery_dataset_id** (string) - **bigquery_dataset_location** (string) - **bigquery_project_id** (string) - **company** (string) - **email** (string) (required) - **email_me_product** (boolean) - **email_preferred** (string) - **image** (string) - **name** (string) - **phone** (string) - **provider** (string) (required) - **token** (string) (required) #### 204 - Accepted Response #### 404 - Not found - **error** (string) (required) #### 422 - Unprocessable Entity - **errors** (object) (required) ### Example Usage ```bash curl -X PUT "https://logflare.app/api/teams/{token}" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "team_users": [ { "email": "string", "name": "string" } ], "token": "string", "user": { "api_key": "string", "api_quota": "0", "bigquery_dataset_id": "string", "bigquery_dataset_location": "string", "bigquery_project_id": "string", "company": "string", "email": "string", "email_me_product": "true", "email_preferred": "string", "image": "string", "name": "string", "phone": "string", "provider": "string", "token": "string" } }' ``` ``` -------------------------------- ### POST /api/rules Source: https://logflare.app/api/openapi API endpoint for POST /api/rules ```markdown ### Request Body **Content-Type:** application/json - **backend_id** (integer) - **id** (integer) - **inserted_at** (string (date-time)) - **lql_string** (string) - **source_id** (integer) - **token** (string) - **updated_at** (string (date-time)) ### Responses #### 201 - Created Response **RuleApiSchema** - **backend_id** (integer) - **id** (integer) - **inserted_at** (string (date-time)) - **lql_string** (string) - **source_id** (integer) - **token** (string) - **updated_at** (string (date-time)) #### 404 - Not found - **error** (string) (required) ### Example Usage ```bash curl -X POST "https://logflare.app/api/rules" \ -H "Content-Type: application/json" \ -d '{ "backend_id": "0", "id": "0", "inserted_at": "2023-01-01T00:00:00Z", "lql_string": "string", "source_id": "0", "token": "string", "updated_at": "2023-01-01T00:00:00Z" }' ``` ``` -------------------------------- ### Schema: Team Source: https://logflare.app/api/openapi Schema definition for Team ```markdown ## Schema: Team Schema definition for Team **Type:** object - **name** (string) (required) - **team_users** (array (object)) Array items: - **email** (string) (required) - **name** (string) (required) - **token** (string) - **user** (object) - **api_key** (string) (required) - **api_quota** (integer) - **bigquery_dataset_id** (string) - **bigquery_dataset_location** (string) - **bigquery_project_id** (string) - **company** (string) - **email** (string) (required) - **email_me_product** (boolean) - **email_preferred** (string) - **image** (string) - **name** (string) - **phone** (string) - **provider** (string) (required) - **token** (string) (required) ``` -------------------------------- ### Schema: SourceListResponse Source: https://logflare.app/api/openapi Schema definition for SourceListResponse ```markdown ## Schema: SourceListResponse Schema definition for SourceListResponse **Type:** array - Array of object - **api_quota** (integer) - **bigquery_table_ttl** (integer) - **bq_table_id** (string) - **custom_event_message_keys** (string) - **default_ingest_backend_enabled?** (boolean) - **favorite** (boolean) - **has_rejected_events** (boolean) - **id** (integer) - **inserted_at** (string (date-time)) - **metrics** (object) - **name** (string) (required) - **notifications** (object) - **public_token** (string) - **slack_hook_url** (string) - **token** (string) - **updated_at** (string (date-time)) - **webhook_notification_url** (string) ``` -------------------------------- ### Schema: BackendApiSchema Source: https://logflare.app/api/openapi Schema definition for BackendApiSchema ```markdown ## Schema: BackendApiSchema Schema definition for BackendApiSchema **Type:** object - **config** (object) - **default_ingest?** (boolean) - **id** (integer) - **inserted_at** (string (date-time)) - **metadata** (object) - **name** (string) (required) - **token** (string) - **updated_at** (string (date-time)) ``` -------------------------------- ### Schema: SourceSchema Source: https://logflare.app/api/openapi Schema definition for SourceSchema ```markdown ## Schema: SourceSchema Schema definition for SourceSchema **Type:** object ``` -------------------------------- ### Schema: AccessTokenListResponse Source: https://logflare.app/api/openapi Schema definition for AccessTokenListResponse ```markdown ## Schema: AccessTokenListResponse Schema definition for AccessTokenListResponse **Type:** array - Array of object - **description** (string) - **id** (integer) - **inserted_at** (string (date-time)) - **scopes** (string) - **token** (string) ```