Do Not Use a carrier on a specific lane

A hard block on this (carrier, lane) pair. Unlike /restrict, which toggles the soft is_active flag, this outranks is_active and is never written by ingestion or the nightly lane derivation — so it survives a sync that would flip a restriction back on. A block set on a wildcard lane (origin with no destination) also blocks every lane out of that origin, including lanes created later. Requires dnu_reason: blocks are long-lived and get inherited. Idempotent, except that re-sending a new dnu_reason updates it. Admin-only — requires OWNER or ADMIN role.

Authentication: Bearer token required.

Authentication

AuthorizationBearer

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

Path parameters

carrier_idstringRequiredformat: "uuid"

preference_idstringRequiredformat: "uuid"

Headers

Idempotency-KeystringOptional<=255 characters

A unique key (up to 255 printable ASCII characters, e.g. a UUID) that makes a retry of this request safe. Envoy stores the response for 24 hours; a retry with the same key and the same request returns it again with Idempotent-Replayed: true instead of running twice. The same key with a different request returns 422 idempotency_key_reused; while the first request is still running, 409 idempotency_key_in_progress. 5xx and 429 responses are not stored.

A unique key (up to 255 printable ASCII characters, e.g. a UUID) that makes a retry of this request safe. Envoy stores the response for 24 hours; a retry with the same key and the same request returns it again with `Idempotent-Replayed: true` instead of running twice. The same key with a different request returns 422 `idempotency_key_reused`; while the first request is still running, 409 `idempotency_key_in_progress`. 5xx and 429 responses are not stored.

Request

This endpoint expects an object.

reasonenumRequired

Constrained reason code; see AuditLogReason for the value set.

dnu_reasonstringRequired1-500 characters

Why this carrier must never be booked on this lane. Shown to whoever inherits the block.

reason_notestring or nullOptional<=2000 characters

Response

Successful Response

idstringformat: "uuid"

carrier_idstringformat: "uuid"

lane_idstringformat: "uuid"

is_activeboolean

preference_typestring

routing_guide_tierinteger or nullOptional

dnubooleanOptionalDefaults to false

dnu_reasonstring or nullOptional

dnu_set_atdatetime or nullOptional

updated_atdatetime or nullOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error