Skip to navigation

Halt the organisation's algos

Stops every started instance of your organisation, in id order, then answers with how many were stopped (algos:manage) — count is 0 when nothing was started, so the call always has an answer. Each instance’s stop is its own change, read on its row.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

Idempotency-KeystringRequired

Required on every write: a URL-safe string of 1 to 64 characters from [A-Za-z0-9._~-] (a UUID fits), scoped to you. It names one operation on one record, ever: a retry replays the stored outcome (Idempotent-Replay: true) or attaches to the live one, and reuse on another record refuses 409 IDEMPOTENCY_KEY_REUSED. Missing or malformed, 400.

Request

This endpoint expects an object.
remarkstringRequired

Why — required on every change, at most 256 bytes of UTF-8.

commandKeystringOptional

The command's idempotency key, 1 to 64 characters of letters, digits, dot, underscore, tilde and hyphen; a replay restates the earlier answer.

Response

The halt as the platform recorded it: count started instances stopped (0 when none was), with the answering change's position and, on a replayed key, Idempotent-Replay.

commandKeystring
The halt's idempotency key, echoed for correlation.
countinteger
How many started instances were stopped.
globalSequencestringformat: "^[0-9]+$"

The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.

haltedAtNsstringformat: "^-?[0-9]+$"
When the halt took effect, epoch nanoseconds. int64 as a decimal JSON string
orgIdinteger
The halted organisation.
remarkstring
The halting user's remark.
userIdinteger or nullOptional
The user who halted.
unscaledbooleanOptionalDeprecated

Never present since 0.3.3: every money value on this API states its own scale on the wire — a policy amount or cap since 0.3.3, an order's and an execution's since 0.3.2, a balance's since 0.3.1 — so a row is never served raw, whether or not this member holds the asset or instrument it references. Kept, deprecated, so a client generated from 0.3.2 still compiles; it goes at the next major.

Errors

400
Halt Algos Request Bad Request Error
401
Halt Algos Request Unauthorized Error
403
Halt Algos Request Forbidden Error
409
Halt Algos Request Conflict Error
413
Halt Algos Request Content Too Large Error
422
Halt Algos Request Unprocessable Entity Error
429
Halt Algos Request Too Many Requests Error
500
Halt Algos Request Internal Server Error
503
Halt Algos Request Service Unavailable Error