How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Redocly Scout API

Scout is Redocly's API-discovery service: it crawls connected Git remotes, tracks pull requests and runs jobs that find hidden, duplicate and undocumented APIs, then pushes what it finds into a Reunite project. The REST API is scoped /orgs/{orgId}/projects/{projectId}/ and covers remotes, jobs, todos, status reporting and metadata validation, with opaque-cursor pagination and RFC 9457 errors. Authentication is a bearer API key issued from the Reunite organization, or the browser session cookie. The server block is templated on {host} because Scout is deployed per customer.

Redocly Scout API is one of 12 APIs that Redocly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include API Catalog, Discovery, and Governance. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 10 operations across 7 paths, organized into 5 resource areas, and defines 15 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://{host}/api.

10 operations 7 paths 15 schemas 3 GET1 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://{host}/api
Authentication
API Key, HTTP Bearer
License
Terms of Service
Resource Areas
5

Authentication & Security 2

Redocly Scout API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as accessToken (UserCookie). It accepts HTTP bearer tokens (ApiKey). By default, every request must be authenticated.

  • UserCookie — Default authentication scheme for interaction between browser and API.
  • ApiKey — API key is required to access the API. You can get your API key from the [BlueHarvest dashboard](https://app.blueharvest.cloud).

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 3 GET, 1 PATCH, 6 POST. They span 5 resource areas: Remotes, Todos, Tasks, Status, Metadata. Each is listed below with its method, path, parameters, and response codes.

Remotes 2

Operations related to remotes.

POST
/orgs/{orgId}/projects/{projectId}/remotes
Upsert remote
upsertRemote 2 params body → 201400
POST
/orgs/{orgId}/projects/{projectId}/remotes/{remoteId}/push
Push files to remote
pushToRemote 3 params body → 200400404
Todos 2

Operations related to todos.

POST
/orgs/{orgId}/projects/{projectId}/scout/todos
Create a job todo
createTodo 3 params body → 201400
GET
/orgs/{orgId}/projects/{projectId}/scout/todos
List all todos
getAllTodos 8 params → 200400
Tasks 4

Operations related to tasks.

POST
/orgs/{orgId}/projects/{projectId}/scout/tasks
Process next job
startNextJob 3 params → 200204400
GET
/orgs/{orgId}/projects/{projectId}/scout/tasks
List all tasks
getAllTasks 8 params → 200400
GET
/orgs/{orgId}/projects/{projectId}/scout/tasks/{jobId}
Get task
getJobById 4 params → 200400404
PATCH
/orgs/{orgId}/projects/{projectId}/scout/tasks/{jobId}
Update job
updateJob 4 params body → 200400404
Status 1

Operations related to status.

POST
/orgs/{orgId}/projects/{projectId}/scout/status
Push status
reportStatus 3 params body → 204400
Metadata 1

Operations related to metadata.

POST
/orgs/{orgId}/projects/{projectId}/scout/metadata/validate
Get metadata validation result
validateMetadata 3 params body → 200400404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Job (20 properties), PullRequest (18 properties), CreateRemote (15 properties), Problem (6 properties). Each schema is shown below with its type and property counts.

GitProviderType
string
Git provider type.
CreateRemote
object
15 properties 2 required
Remote
Problem
object
6 properties 4 required
RemotePush
object
4 properties 2 required
PullRequest
object
18 properties 10 required
Page
object
6 properties 6 required
GitCommitCheck
object
4 properties 2 required
JobMetadata
object
Additional information about job.
3 properties
Job
object
20 properties 11 required
JobList
object
3 properties 3 required
PatchJob
object
2 properties 1 required
Status
object
5 properties 5 required
Metadata
object
Any object shape.
MetadataValidationResult
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

redocly-scout-openapi.yaml Raw ↑

Other APIs Redocly publishes across the network.

Redocly Realm
Redocly Reunite
Redocly Revel
Redocly Reef
Redocly Redoc
Redocly CLI
Redocly Respect Monitoring
Arazzo Specification (Redocly Tooling)
Redocly Realm Search API
Redocly Docs MCP Server
Redocly Scout Agent API
Where this information came from

This is an independent, third-party profile of Redocly Scout 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.