Public REST/JSON reference

API Watchdog API

Monitor third-party API changelogs, blog feeds, and status pages so a breaking change in Stripe / Twilio / SendGrid / OpenAI doesn't surface as a 5am page. Register the APIs you depend on, register your dependencies (which endpoints you actually use), and the watchdog matches detected changes against your dependencies — assigning impact level (LOW → CRITICAL) and listing exactly which integration points are affected. Part of the Logic Igniter Developer & DevOps bundle.

Access boundary

These examples describe public API calls only. Use the service output to review, score, summarize, analyze, or recommend; do not treat the API reference as permission for an assistant to write, send, publish, charge, schedule, notify, delete, or modify records.

Base URL

https://api.logicigniter.com

Auth

Authorization: Bearer YOUR_API_KEY

Version

OpenAPI 3.0.3 · 1.0.0

Spec

/api-specs/apiwatchdog.json

Operations rendered

Response models rendered

GET/api/v1/apiwatchdog/health

Service liveness

Liveness probe — returns 200 if the service is reachable.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/apiwatchdog/health" \
  -H "Accept: application/json"

Responses

200

Service healthy

GET/api/v1/apiwatchdog/customers

List customers

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`page_size`	query	integer
`page_token`	query	string

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/apiwatchdog/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CustomersResponse

Page of customers

401Error

Missing or invalid API key.

POST/api/v1/apiwatchdog/customers

Provision a customer

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: CreateCustomerRequest

Sample JSON payload for evaluation.

{
  "email": "[email protected]",
  "name": "Example Inc."
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/apiwatchdog/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]","name":"Example Inc."}'

Responses

201Customer

Customer created or returned

400Error

Invalid email or missing name

401Error

Missing or invalid API key.

GET/api/v1/apiwatchdog/customers/{id}

Get a customer by id

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/apiwatchdog/customers/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200Customer

Customer record

401Error

Missing or invalid API key.

404Error

Customer not found

PUT/api/v1/apiwatchdog/customers/{id}

Update a customer

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string (uuid)

Request body (required)

Schema: UpdateCustomerRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X PUT "https://api.logicigniter.com/api/v1/apiwatchdog/customers/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

200Customer

Updated customer

400Error

Invalid update

401Error

Missing or invalid API key.

404Error

Customer not found

GET/api/v1/apiwatchdog/apis

List monitored APIs

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`page_size`	query	integer
`page_token`	query	string

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/apiwatchdog/apis" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200APIsResponse

Page of APIs

401Error

Missing or invalid API key.

POST/api/v1/apiwatchdog/apis

Add an API to monitor

Register a third-party API by changelog/blog/status-page URLs. The watchdog polls each source at the requested CheckFrequency and emits ChangelogEntry records when something new is detected.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: AddAPIRequest

Sample JSON payload for evaluation.

{
  "name": "stripe",
  "changelog_url": "https://stripe.com/docs/changelog",
  "blog_feed_url": "https://stripe.com/blog/feed.rss",
  "status_page_url": "https://status.stripe.com",
  "check_frequency": "CHECK_FREQUENCY_DAILY"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/apiwatchdog/apis" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name":"stripe","changelog_url":"https://stripe.com/docs/changelog","blog_feed_url":"https://stripe.com/blog/feed.rss","status_page_url":"https://status.stripe.com","check_frequency":"CHECK_FREQUENCY_DAILY"}'

Responses

201MonitoredAPI

API registered

400Error

Missing name or unparseable URLs

401Error

Missing or invalid API key.

402Error

Endpoint requires an active subscription. Free tier covers 3 monitored APIs with daily polling; paid plans unlock unlimited APIs, hourly polling, and impact assessment.

POST/api/v1/apiwatchdog/apis/{api_id}/check

Force an immediate check

Trigger an out-of-band check for one API right now (instead of waiting for the next scheduled poll). Useful right after a vendor announces a release.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`api_id`required	path	string (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/apiwatchdog/apis/:api_id/check" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CheckResult

Check result — including any newly-detected changes

401Error

Missing or invalid API key.

402Error

Endpoint requires an active subscription. Free tier covers 3 monitored APIs with daily polling; paid plans unlock unlimited APIs, hourly polling, and impact assessment.

404Error

API not found

POST/api/v1/apiwatchdog/apis/{api_id}/dependencies

Register a dependency on this API

Tell the watchdog which endpoints of this API your codebase actually uses (e.g. `POST /v1/charges`, `GET /v1/customers/*`). Subsequent change-impact assessments compare detected changes against this list.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`api_id`required	path	string (uuid)

Request body (required)

Schema: RegisterDepRequest

Sample JSON payload for evaluation.

{
  "endpoint_pattern": "POST /v1/charges",
  "usage_description": "Used by checkout-service to capture payments."
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/apiwatchdog/apis/:api_id/dependencies" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"endpoint_pattern":"POST /v1/charges","usage_description":"Used by checkout-service to capture payments."}'

Responses

201Dependency

Dependency registered

400Error

Missing endpoint_pattern

401Error

Missing or invalid API key.

404Error

API not found

GET/api/v1/apiwatchdog/changes

List detected changes

Workspace-wide stream of detected changelog entries across all monitored APIs. Optionally filter by minimum severity (e.g. only show CRITICAL).

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type
`severity`	query	ChangeSeverity
`page_size`	query	integer
`page_token`	query	string

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/apiwatchdog/changes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200ChangesResponse

Page of changelog entries

401Error

Missing or invalid API key.

GET/api/v1/apiwatchdog/changes/{entry_id}

Get a single change with full detail

Returns the full ChangeDetail including affected_endpoints, migration_deadline (if vendor announced one), and the raw_text the watchdog parsed.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`entry_id`required	path	string (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/apiwatchdog/changes/:entry_id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200ChangeDetail

Change detail

401Error

Missing or invalid API key.

404Error

Entry not found

GET/api/v1/apiwatchdog/apis/{api_id}/timeline

API change timeline

All ChangelogEntry records for one API in reverse chronological order — the historical view used in audit reviews and post-mortems.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`api_id`required	path	string (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/apiwatchdog/apis/:api_id/timeline" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200Timeline

Timeline

401Error

Missing or invalid API key.

404Error

API not found

GET/api/v1/apiwatchdog/changes/{entry_id}/impact

Assess impact against your dependencies

Returns the impact level (LOW/MEDIUM/HIGH/CRITICAL), recommended action_required, and the list of your registered dependencies that match the change's affected_endpoints.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`entry_id`required	path	string (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/apiwatchdog/changes/:entry_id/impact" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200ImpactAssessment

Impact assessment

401Error

Missing or invalid API key.

402Error

Endpoint requires an active subscription. Free tier covers 3 monitored APIs with daily polling; paid plans unlock unlimited APIs, hourly polling, and impact assessment.

404Error

Entry not found

GET/api/v1/apiwatchdog/changes/{entry_id}/affected

List dependencies affected by a change

Just the affected dependencies — no overall assessment. Suitable when you've already triaged the change and want a flat list to ticket against.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`entry_id`required	path	string (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/apiwatchdog/changes/:entry_id/affected" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200AffectedResponse

Affected dependencies

401Error

Missing or invalid API key.

404Error

Entry not found

Data models

Error

Field	Type	Notes
`error`required	string

ImpactLevel

ChangeType

ChangeSeverity

CheckFrequency

AddAPIRequest

Field	Type	Notes
`name`required	string	Example: "stripe"
`changelog_url`	string (uri)
`blog_feed_url`	string (uri)
`status_page_url`	string (uri)
`check_frequency`	CheckFrequency

MonitoredAPI

Field	Type	Notes
`id`	string (uuid)
`name`	string
`changelog_url`	string (uri)
`check_frequency`	CheckFrequency
`last_checked_at`	string (date-time)

APIsResponse

Field	Type	Notes
`items`	array<MonitoredAPI>
`next_page_token`	string
`total_count`	integer

CheckResult

Field	Type	Notes
`id`	string (uuid)
`changes_detected`	boolean
`changes_count`	integer

RegisterDepRequest

Field	Type	Notes
`endpoint_pattern`required	string	Example: "POST /v1/charges"
`usage_description`	string

Dependency

Field	Type	Notes
`id`	string (uuid)
`api_id`	string (uuid)
`endpoint_pattern`	string
`usage_description`	string

ChangelogEntry

Field	Type	Notes
`id`	string (uuid)
`api_id`	string (uuid)
`title`	string
`change_type`	ChangeType
`severity`	ChangeSeverity
`detected_at`	string (date-time)

ChangesResponse

Field	Type	Notes
`items`	array<ChangelogEntry>
`next_page_token`	string
`total_count`	integer

ChangeDetail

Field	Type	Notes
`id`	string (uuid)
`api_id`	string (uuid)
`title`	string
`change_type`	ChangeType
`severity`	ChangeSeverity
`affected_endpoints`	array<string>
`migration_deadline`	string (date-time)
`raw_text`	string

Timeline

Field	Type	Notes
`id`	string (uuid)
`entries`	array<ChangelogEntry>

AffectedDep

Field	Type	Notes
`dependency_id`	string (uuid)
`endpoint_pattern`	string
`impact_level`	ImpactLevel

ImpactAssessment

Field	Type	Notes
`id`	string (uuid)
`entry_id`	string (uuid)
`impact_level`	ImpactLevel
`action_required`	string
`affected`	array<AffectedDep>

AffectedResponse

Field	Type	Notes
`items`	array<AffectedDep>

CreateCustomerRequest

Field	Type	Notes
`email`required	string (email)
`name`required	string

UpdateCustomerRequest

Field	Type	Notes
`email`	string (email)
`name`	string

Customer

Field	Type	Notes
`id`	string (uuid)
`email`	string (email)
`name`	string
`created_at`	string (date-time)

CustomersResponse

Field	Type	Notes
`items`	array<Customer>
`next_page_token`	string
`total_count`	integer