ValidateForwarderConfig

Checks whether a forwarder token and environment ID are a usable
pair, and any asset groups the forwarder will join are static groups
in that environment, before a forwarder is installed with them.

Forwarder installers take these values from whoever is running the
install. A typo in the token or environment produces a forwarder that
starts cleanly and then silently never reports, and a bad group fails
its registration. Call this first and gate the install on valid.

This is the one endpoint on this API that does NOT authenticate
with the Authorization header: the credential under test is
supplied in the request body instead, because the caller is trying
to find out whether it is a credential at all. Send nothing in the
Authorization header.

The response is deliberately a bare boolean. It never reveals
whether an environment exists, who owns it, or why a configuration
was rejected.

Callers MUST treat HTTP 429 as "try again shortly", never as
"invalid". The endpoint is rate limited, and answering a 429 as
though it were a validation failure would block installs that are
perfectly well configured. Retry with backoff instead.

Only rejected answers count against the limit, so a large, correctly
configured rollout does not accumulate against it however many
endpoints it covers. Repeatedly asking about a configuration that is wrong
is what will eventually be throttled.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request message for ValidateForwarderConfig RPC.

string
required

The environment ID the forwarder will report into, as shown in the
Stairwell UI (e.g. VXKCDN-GSPRN8-M4QW7Z-2TPLJHK9). The
environments/ resource-name prefix is accepted but not required.

Whatever the installer collected goes here verbatim. A malformed or
unknown value is answered with valid: false, not an error.

string
required

The forwarder token the forwarder will authenticate with, as issued
by the Stairwell UI ("File forwarder token").

It must be a forwarder token specifically. A personal or administrator
API token is answered valid: false even where that user could create
assets in the environment, because deploying a human's credential across
an endpoint fleet is precisely the misconfiguration this check exists to
catch.

Send it here, in the body — NOT in the Authorization header. As
with environment, a malformed or unknown value is answered with
valid: false.

groups
array of strings

The asset groups the forwarder will ask to join when it registers
(CreateAsset's groups), as group IDs or groups/{id} resource names.
Each must be a static group in environment; a group that does not
exist there, or is dynamic, is answered with valid: false, as
registration would fail with it.

groups
Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json