Sign in
External APIs

Invoke an externally-exposed swarm script

Runs the script bound to this endpoint and returns a JSON envelope { ok, result, error, durationMs } (HTTP 200) once execution is reached. Auth/routing failures use 401 (bad/missing bearer) and 404 (unknown or disabled endpoint). Optional X-Swarm-Timeout-Ms header (default 60000, clamped 1000–300000) sets the wall-clock timeout.

post/api/x/script/{endpointId}

Path parameters

endpointIdstring required

Response

Script executed — see ok in the envelope

okboolean required
{"stackTrail":"paths:/api/x/script/{endpointId}:post:responses:200:content:application/json:schema:properties:result","oasType":"schema","type":"unknown"}
durationMsnumber required

Changes

Changed in 1 of the 104 revisions of this API.4

  • 06cac6a7c5bc4See the full diff
    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added