The Log Management API provides access to execution logs produced by the Hoody exec subsystem. Use these endpoints to list available log files, read or stream their contents, search across multiple files, and clear log data by file or age.

List Logs

GET /api/v1/exec/logs/list

Returns the set of available execution log files. Results can be filtered by type and limited in count.

Parameters

Name	In	Type	Required	Description
type	query	string	No	Type query parameter
limit	query	string	No	Limit query parameter

cURL

curl -X GET "https://api.hoody.com/api/v1/exec/logs/list?type=execution&limit=50" \
  -H "Authorization: Bearer <token>"

SDK

const result = await client.exec.logs.list({
  type: "execution",
  limit: "50",
});

200

{
  "logs": [
    {
      "file": "exec-2024-01-15.log",
      "size": 4096,
      "modified": "2024-01-15T10:30:00Z"
    },
    {
      "file": "exec-2024-01-14.log",
      "size": 8192,
      "modified": "2024-01-14T18:22:11Z"
    }
  ],
  "count": 2
}

400

{
  "error": "VALIDATION_ERROR",
  "code": "VALIDATION_ERROR",
  "timestamp": "2024-01-15T10:30:00Z",
  "details": {
    "field": "limit",
    "issue": "must be a positive integer"
  }
}

Error Code	Title	Description	Resolution
VALIDATION_ERROR	Invalid input	Request parameters failed validation	Check parameter format and requirements

500

{
  "error": "Internal server error",
  "code": "ERROR_500",
  "timestamp": "2024-01-15T10:30:00Z"
}

Stream Logs

GET /api/v1/exec/logs/stream

Streams the contents of a single log file. Pass follow=true to keep the connection open and receive new lines as they are appended.

Parameters

Name	In	Type	Required	Description
file	query	string	Yes	File query parameter
follow	query	string	No	Follow query parameter

cURL

curl -X GET "https://api.hoody.com/api/v1/exec/logs/stream?file=exec-2024-01-15.log&follow=true" \
  -H "Authorization: Bearer <token>"

SDK

const result = await client.exec.logs.stream({
  file: "exec-2024-01-15.log",
  follow: "true",
});

400

{
  "error": "VALIDATION_ERROR",
  "code": "VALIDATION_ERROR",
  "timestamp": "2024-01-15T10:30:00Z",
  "details": {
    "field": "file",
    "issue": "missing required parameter"
  }
}

Error Code	Title	Description	Resolution
VALIDATION_ERROR	Invalid input	Request parameters failed validation	Check parameter format and requirements

404

{
  "error": "NOT_FOUND",
  "code": "NOT_FOUND",
  "timestamp": "2024-01-15T10:30:00Z",
  "details": {
    "resource": "log file",
    "identifier": "exec-2024-01-15.log"
  }
}

Error Code	Title	Description	Resolution
NOT_FOUND	Resource not found	The requested resource does not exist	Verify the resource identifier

500

{
  "error": "Internal server error",
  "code": "ERROR_500",
  "timestamp": "2024-01-15T10:30:00Z"
}

Read Log

POST /api/v1/exec/logs/read

Reads a range of lines from a log file, with optional filtering and tail/head behavior.

Request Body

Name	Type	Required	Default	Description
file	string	No	—	File
executionId	string	No	—	Execution Id
lines	integer	No	100	Lines
tail	boolean	No	true	Tail
search	string	No	—	Search

cURL

curl -X POST "https://api.hoody.com/api/v1/exec/logs/read" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "file": "exec-2024-01-15.log",
    "executionId": "exec_a1b2c3d4",
    "lines": 200,
    "tail": true,
    "search": "ERROR"
  }'

SDK

const result = await client.exec.logs.read({
  file: "exec-2024-01-15.log",
  executionId: "exec_a1b2c3d4",
  lines: 200,
  tail: true,
  search: "ERROR",
});

200

{
  "file": "exec-2024-01-15.log",
  "totalLines": 1024,
  "filteredLines": 7,
  "returnedLines": 7,
  "lines": [
    "2024-01-15T10:30:01Z [ERROR] Database connection refused",
    "2024-01-15T10:30:02Z [ERROR] Retry attempt 1 failed",
    "2024-01-15T10:30:04Z [ERROR] Retry attempt 2 failed"
  ],
  "size": 4096,
  "modified": "2024-01-15T10:35:00Z"
}

400

{
  "error": "VALIDATION_ERROR",
  "code": "VALIDATION_ERROR",
  "timestamp": "2024-01-15T10:30:00Z",
  "details": {
    "field": "lines",
    "issue": "must be a positive integer"
  }
}

Error Code	Title	Description	Resolution
VALIDATION_ERROR	Invalid input	Request parameters failed validation	Check parameter format and requirements

404

{
  "error": "NOT_FOUND",
  "code": "NOT_FOUND",
  "timestamp": "2024-01-15T10:30:00Z",
  "details": {
    "resource": "log file",
    "identifier": "exec-2024-01-15.log"
  }
}

Error Code	Title	Description	Resolution
NOT_FOUND	Resource not found	The requested resource does not exist	Verify the resource identifier

500

{
  "error": "Internal server error",
  "code": "ERROR_500",
  "timestamp": "2024-01-15T10:30:00Z"
}

Search Logs

POST /api/v1/exec/logs/search

Searches across one or more log files using either a plain substring query or a regular expression. Results are returned as an array of matches with surrounding context.

Request Body

Name	Type	Required	Default	Description
query	string	No	—	Query
regex	string	No	—	Regex
files	array	No	—	Files
limit	integer	No	1000	Limit
caseSensitive	boolean	No	false	Case Sensitive

cURL

curl -X POST "https://api.hoody.com/api/v1/exec/logs/search" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "connection refused",
    "files": ["exec-2024-01-15.log", "exec-2024-01-14.log"],
    "limit": 500,
    "caseSensitive": false
  }'

SDK

const result = await client.exec.logs.search({
  query: "connection refused",
  files: ["exec-2024-01-15.log", "exec-2024-01-14.log"],
  limit: 500,
  caseSensitive: false,
});

200

{
  "query": "connection refused",
  "searchType": "substring",
  "filesSearched": 2,
  "matchesFound": 3,
  "results": [
    {
      "file": "exec-2024-01-15.log",
      "line": 142,
      "content": "2024-01-15T10:30:01Z [ERROR] Database connection refused"
    },
    {
      "file": "exec-2024-01-14.log",
      "line": 88,
      "content": "2024-01-14T18:22:11Z [ERROR] Upstream connection refused"
    }
  ]
}

400

{
  "error": "VALIDATION_ERROR",
  "code": "VALIDATION_ERROR",
  "timestamp": "2024-01-15T10:30:00Z",
  "details": {
    "field": "regex",
    "issue": "invalid regular expression"
  }
}

Error Code	Title	Description	Resolution
VALIDATION_ERROR	Invalid input	Request parameters failed validation	Check parameter format and requirements

500

{
  "error": "Internal server error",
  "code": "ERROR_500",
  "timestamp": "2024-01-15T10:30:00Z"
}

Clear Logs

DELETE /api/v1/exec/logs/clear

Deletes log files matching the supplied filters. Use confirm=true to acknowledge a destructive operation. Combine with olderThanDays to target only stale logs.

Parameters

Name	In	Type	Required	Description
file	query	string	No	File query parameter
type	query	string	No	Type query parameter
olderThanDays	query	string	No	OlderThanDays query parameter
confirm	query	string	No	Confirm query parameter

cURL

curl -X DELETE "https://api.hoody.com/api/v1/exec/logs/clear?type=execution&olderThanDays=30&confirm=true" \
  -H "Authorization: Bearer <token>"

SDK

const result = await client.exec.logs.clear({
  type: "execution",
  olderThanDays: "30",
  confirm: "true",
});

200

{
  "deleted": 15,
  "totalSize": 524288,
  "message": "Logs cleared successfully"
}

400

{
  "error": "VALIDATION_ERROR",
  "code": "VALIDATION_ERROR",
  "timestamp": "2024-01-15T10:30:00Z",
  "details": {
    "field": "confirm",
    "issue": "must be true to acknowledge destructive action"
  }
}

Error Code	Title	Description	Resolution
VALIDATION_ERROR	Invalid input	Request parameters failed validation	Check parameter format and requirements

500

{
  "error": "Internal server error",
  "code": "ERROR_500",
  "timestamp": "2024-01-15T10:30:00Z"
}