enroll
Track a site's official data route and required signup steps, then manage open requests, host details, approval status, and completion for Scout updates.
Instructions
Official routes and the enrollments they need: the checklist for whoever updates Scout.
action=list: open requests, each with a todo that says where to sign up, what it costs, and where the key goes.
action=request host info: record a site's official route. info = {route: open_api|bulk|feed|public_json|alternative
(no signup) or enroll_free|enroll_paid|enroll_oauth|commercial (a person must enroll), name, signup_url, docs_url,
base_url, auth: {kind: none|query|header|bearer|oauth2_client_credentials, name, token_url, headers}, cost, terms,
sample (a url that returns the data; leave the key out)}. Keyed routes become an enrollment request.
action=applied (signed up, waiting on approval) | done (Scout tests the key on the sample, then marks enrolled) | decline.
Keys are never passed here: they go in the keys file or SCOUT_KEY_ env vars.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| host | No | ||
| info | No | ||
| note | No | ||
| action | No | list | |
| include_all | No |