Redocly Scout Agent API
The Scout agent is the self-hosted worker half of Scout, deployed inside the customer's own infrastructure (Redocly documents an AWS ECS task definition). Its API is small and operational: a health check plus two webhook receivers that accept GitHub and GitLab events, authenticated by the x-hub-signature-256 and x-gitlab-token signature headers respectively. Errors are RFC 9457 problem documents and the 500 problem carries an `event` member naming the incoming webhook event.
Redocly Scout Agent API is one of 12 APIs that Redocly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Discovery, Webhook, and Self-Hosted. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 3 operations across 3 paths, organized into 2 resource areas, and defines 37 schemas. It is described by OpenAPI 3.1.0, at version 1.0.
Requests are made against a single base URL, {host}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Redocly Scout Agent API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as x-hub-signature-256 (GithubApiKey).
An API key is passed in the header as x-gitlab-token (GitlabApiKey).
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 1 GET, 2 POST. They span 2 resource areas: Health, Webhooks. Each is listed below with its method, path, parameters, and response codes.
Operations related to health checks.
Operations related to incoming git webhooks.
Schemas 37
The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are repository (90 properties), pull-request (48 properties), merge-request-details (22 properties), user (20 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Redocly 11
Other APIs Redocly publishes across the network.
This is an independent, third-party profile of Redocly Scout Agent API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.