CLI command
weles tasks cancel
Cancel one task with --reason through the public task API (POST /api/v1/tasks/<id>/cancel) with the bearer of the item playing --role, and print what it answered.
Purpose#
Cancel one task with --reason through the public task API (POST /api/v1/tasks/<id>/cancel) with the bearer of the item playing --role, and print what it answered.
Invocation#
weles tasks cancel <task-id> --reason <text> (--consumer <consumer> | --endpoint <url>) --role <role> [--idempotency-key <key>] [--json]Options#
| Option | Effect |
|---|---|
--reason | weles --help names this option in the usage line and gives it no description. |
--consumer | tasks: the Stado consumer the caller is; the API is the route 'stado service directory connect weles-admission --consumer <consumer>' gives. |
--endpoint | tasks: the public task API's address instead of a consumer's route. |
--role | tasks: the vault role whose item holds the bearer (token) and, for cancel, the organization (organization_id) the API admits. |
--idempotency-key | weles --help names this option in the usage line and gives it no description. |
--json | Print the answer as one JSON document instead of key: value lines. release surface always prints its JSON document: it is the file a release carries. |
Help#
`weles tasks cancel --help` prints these usage lines and never runs the command.