Skip to content

SuspendReadyQueueV1Request

Note

This page was generated by extracting information from a JSON Schema data file for the API. It may be missing some information, or otherwise suggest approximate or placeholder values based on information in the schema file; this is due to limitations on how that data is extracted from the underlying Rust code and into the JSON Schema, and then again from there and into these docs.

This is an object value, with the following properties:

  • duration - optional nullable string. Specifies how long this suspension remains active.

  • expires - optional nullable string (date-time).

  • name - required string. The name of the ready queue that should be suspended

  • reason - required string. The reason for the suspension

Examples

{
  "duration": "string",
  "expires": "1990-12-31T23:59:60Z",
  "name": "source_name->(alt1|alt2|alt3|alt4)?.gmail-smtp-in.l.google.com@smtp_client",
  "reason": "pause while working on resolving a block with the destination postmaster"
}