Lift a Do Not Use block on a specific lane

Clears the hard block. Deliberately does NOT restore is_active: a lane that was paused AND blocked stays paused, since re-deriving the rep’s original intent from a cleared block would be a guess — call /unrestrict as well to re-enable it. Provenance is cleared so a later block cannot inherit this one’s author. Idempotent. Admin-only.

Authentication: Bearer token required.

Clears the hard block. Deliberately does NOT restore is_active: a lane that was paused AND blocked stays paused, since re-deriving the rep's original intent from a cleared block would be a guess — call /unrestrict as well to re-enable it. Provenance is cleared so a later block cannot inherit this one's author. Idempotent. Admin-only. **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.

reasonenum or nullOptional

Allowed values for AuditLog.reason. DB-enforced via Postgres ENUM.

The set is intentionally shared across all entity_type contexts; the same code (service_quality, compliance, other) means different things depending on whether the audited row is a carrier or a lane preference. Disambiguating is the caller’s job — the frontend renders different human labels per context. Free-text justification lands on AuditLog.reason_note — required when OTHER is chosen, optional (but preserved) for any other code.

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