Get service readiness

Error

A valid request URL is required to generate request examples

{
  "service": "<string>",
  "status": "starting",
  "degradedState": "none",
  "journalSequence": 1,
  "runtimePolicyVersion": "<string>",
  "sourceDigest": "<string>",
  "journalTail": {
    "active": "engine_page_route",
    "reasonCode": "journal_configuration:accounting_epoch_missing",
    "sources": [
      {
        "source": "main",
        "lastSequence": 1
      }
    ]
  },
  "replication": {
    "read": true,
    "leaderFailureDomainDeclared": true,
    "hasQualifyingStandby": true,
    "reportingStandbyCount": 1,
    "refusedStandbyCount": 1,
    "lastQualifyingObservationAgeMs": 1,
    "unavailableReason": "cpp_writer_front_not_composed"
  },
  "marketBook": {
    "composed": true,
    "markets": [
      {
        "marketId": "<string>",
        "lastPolledAtEpochMs": 1,
        "lastPublishedAtEpochMs": 1,
        "lastSnapshotSequence": 1,
        "consecutiveFailures": 1,
        "lastFailureReason": "market_book:request_failed"
      }
    ]
  },
  "degradedLeg": "projector",
  "degradedLegState": "not_composed",
  "degradedReason": "<string>",
  "degradedReasonCode": "journal_configuration:accounting_epoch_missing",
  "engineTransport": {
    "active": "http",
    "requested": "aeron_ipc_cpp",
    "composed": true
  },
  "cantonOffline": {
    "policyReadable": true,
    "policyVersion": "<string>",
    "engaged": true,
    "enforcing": true,
    "enforcedLegs": [
      "deposit_intake"
    ]
  },
  "coreTreasury": {
    "installed": true,
    "accountId": "<string>",
    "lastRefusal": "<string>"
  },
  "coreMirror": {
    "enabled": true,
    "mirroredOrdinal": 1,
    "edjcTipOrdinal": 1,
    "lastRefusal": {
      "reason": "duplicate_ordinal",
      "ordinal": 1,
      "detail": "<string>"
    },
    "lastPollAtEpochMs": 123,
    "mirroredSinceStart": 1
  }
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

{
  "service": "<string>",
  "status": "starting",
  "degradedState": "none",
  "journalSequence": 1,
  "runtimePolicyVersion": "<string>",
  "sourceDigest": "<string>",
  "journalTail": {
    "active": "engine_page_route",
    "reasonCode": "journal_configuration:accounting_epoch_missing",
    "sources": [
      {
        "source": "main",
        "lastSequence": 1
      }
    ]
  },
  "replication": {
    "read": true,
    "leaderFailureDomainDeclared": true,
    "hasQualifyingStandby": true,
    "reportingStandbyCount": 1,
    "refusedStandbyCount": 1,
    "lastQualifyingObservationAgeMs": 1,
    "unavailableReason": "cpp_writer_front_not_composed"
  },
  "marketBook": {
    "composed": true,
    "markets": [
      {
        "marketId": "<string>",
        "lastPolledAtEpochMs": 1,
        "lastPublishedAtEpochMs": 1,
        "lastSnapshotSequence": 1,
        "consecutiveFailures": 1,
        "lastFailureReason": "market_book:request_failed"
      }
    ]
  },
  "degradedLeg": "projector",
  "degradedLegState": "not_composed",
  "degradedReason": "<string>",
  "degradedReasonCode": "journal_configuration:accounting_epoch_missing",
  "engineTransport": {
    "active": "http",
    "requested": "aeron_ipc_cpp",
    "composed": true
  },
  "cantonOffline": {
    "policyReadable": true,
    "policyVersion": "<string>",
    "engaged": true,
    "enforcing": true,
    "enforcedLegs": [
      "deposit_intake"
    ]
  },
  "coreTreasury": {
    "installed": true,
    "accountId": "<string>",
    "lastRefusal": "<string>"
  },
  "coreMirror": {
    "enabled": true,
    "mirroredOrdinal": 1,
    "edjcTipOrdinal": 1,
    "lastRefusal": {
      "reason": "duplicate_ordinal",
      "ordinal": 1,
      "detail": "<string>"
    },
    "lastPollAtEpochMs": 123,
    "mirroredSinceStart": 1
  }
}

GET

ready

Error

A valid request URL is required to generate request examples

{
  "service": "<string>",
  "status": "starting",
  "degradedState": "none",
  "journalSequence": 1,
  "runtimePolicyVersion": "<string>",
  "sourceDigest": "<string>",
  "journalTail": {
    "active": "engine_page_route",
    "reasonCode": "journal_configuration:accounting_epoch_missing",
    "sources": [
      {
        "source": "main",
        "lastSequence": 1
      }
    ]
  },
  "replication": {
    "read": true,
    "leaderFailureDomainDeclared": true,
    "hasQualifyingStandby": true,
    "reportingStandbyCount": 1,
    "refusedStandbyCount": 1,
    "lastQualifyingObservationAgeMs": 1,
    "unavailableReason": "cpp_writer_front_not_composed"
  },
  "marketBook": {
    "composed": true,
    "markets": [
      {
        "marketId": "<string>",
        "lastPolledAtEpochMs": 1,
        "lastPublishedAtEpochMs": 1,
        "lastSnapshotSequence": 1,
        "consecutiveFailures": 1,
        "lastFailureReason": "market_book:request_failed"
      }
    ]
  },
  "degradedLeg": "projector",
  "degradedLegState": "not_composed",
  "degradedReason": "<string>",
  "degradedReasonCode": "journal_configuration:accounting_epoch_missing",
  "engineTransport": {
    "active": "http",
    "requested": "aeron_ipc_cpp",
    "composed": true
  },
  "cantonOffline": {
    "policyReadable": true,
    "policyVersion": "<string>",
    "engaged": true,
    "enforcing": true,
    "enforcedLegs": [
      "deposit_intake"
    ]
  },
  "coreTreasury": {
    "installed": true,
    "accountId": "<string>",
    "lastRefusal": "<string>"
  },
  "coreMirror": {
    "enabled": true,
    "mirroredOrdinal": 1,
    "edjcTipOrdinal": 1,
    "lastRefusal": {
      "reason": "duplicate_ordinal",
      "ordinal": 1,
      "detail": "<string>"
    },
    "lastPollAtEpochMs": 123,
    "mirroredSinceStart": 1
  }
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

{
  "version": "external-rest-error/v1",
  "requestId": "<string>",
  "code": "invalid_request",
  "safeMessage": "<string>",
  "retryable": true,
  "recoveryActions": [
    "none"
  ],
  "occurredAtEpochMs": 1,
  "realtimeTicketFailure": "invalid"
}

{
  "service": "<string>",
  "status": "starting",
  "degradedState": "none",
  "journalSequence": 1,
  "runtimePolicyVersion": "<string>",
  "sourceDigest": "<string>",
  "journalTail": {
    "active": "engine_page_route",
    "reasonCode": "journal_configuration:accounting_epoch_missing",
    "sources": [
      {
        "source": "main",
        "lastSequence": 1
      }
    ]
  },
  "replication": {
    "read": true,
    "leaderFailureDomainDeclared": true,
    "hasQualifyingStandby": true,
    "reportingStandbyCount": 1,
    "refusedStandbyCount": 1,
    "lastQualifyingObservationAgeMs": 1,
    "unavailableReason": "cpp_writer_front_not_composed"
  },
  "marketBook": {
    "composed": true,
    "markets": [
      {
        "marketId": "<string>",
        "lastPolledAtEpochMs": 1,
        "lastPublishedAtEpochMs": 1,
        "lastSnapshotSequence": 1,
        "consecutiveFailures": 1,
        "lastFailureReason": "market_book:request_failed"
      }
    ]
  },
  "degradedLeg": "projector",
  "degradedLegState": "not_composed",
  "degradedReason": "<string>",
  "degradedReasonCode": "journal_configuration:accounting_epoch_missing",
  "engineTransport": {
    "active": "http",
    "requested": "aeron_ipc_cpp",
    "composed": true
  },
  "cantonOffline": {
    "policyReadable": true,
    "policyVersion": "<string>",
    "engaged": true,
    "enforcing": true,
    "enforcedLegs": [
      "deposit_intake"
    ]
  },
  "coreTreasury": {
    "installed": true,
    "accountId": "<string>",
    "lastRefusal": "<string>"
  },
  "coreMirror": {
    "enabled": true,
    "mirroredOrdinal": 1,
    "edjcTipOrdinal": 1,
    "lastRefusal": {
      "reason": "duplicate_ordinal",
      "ordinal": 1,
      "detail": "<string>"
    },
    "lastPollAtEpochMs": 123,
    "mirroredSinceStart": 1
  }
}

Response

Success

service

string

required

Minimum string length: 1

status

enum<string>

required

Available options:

starting,

ready,

degraded,

unavailable

degradedState

enum<string>

required

Available options:

none,

warmup,

paused,

draining_to_journal,

runtime_policy_unavailable,

database_unavailable,

journal_unavailable,

projection_group_not_owned,

projection_stale,

replica_lagging,

projector_backfilling,

market_data_unavailable,

canton_unavailable,

signer_unavailable,

reconciliation_blocked,

kill_switch_active,

authority_unreachable,

unknown_command_outcome,

action_requires_approval,

dry_run_expired,

unsafe_action_blocked

journalSequence

integer | null

required

Required range: x >= 0

runtimePolicyVersion

string | null

required

Minimum string length: 1

sourceDigest

string

Minimum string length: 1

journalTail

object

Show child attributes

replication

object

Show child attributes

marketBook

object

Show child attributes

degradedLeg

enum<string> | null

Available options:

projector,

canton_stream,

canton_runtime_identity,

reconciliation,

settlement,

withdrawal_consume,

jetstream_consumer,

engine_cpp_transport,

core_mirror,

engine_replication

degradedLegState

enum<string> | null

Available options:

not_composed,

run_failed,

awaiting_first_run,

not_caught_up,

group_not_owned,

identity_unverified,

halt_engaged,

halt_delivery_failed,

margin_configuration_upgrade_pending,

refused_stopped,

standby_absent

degradedReason

string | null

Minimum string length: 1

degradedReasonCode

enum<string> | null

Available options:

journal_configuration:accounting_epoch_missing,

journal_configuration:accounting_epoch_mismatch,

journal_configuration:page_request_invalid,

journal_configuration:service_identity_required,

journal_configuration:writer_provenance_invalid,

journal_configuration:per_record_fsync_required,

journal_configuration:synchronous_commit_required,

journal_configuration:engine_url_required,

journal_configuration:engine_url_invalid,

journal_configuration:service_secret_required,

journal_configuration:service_secret_invalid,

journal_lock:writer_lock_state_invalid,

journal_lock:writer_lock_held,

journal_lock:writer_lock_invalid,

journal_lock:advisory_lock_held,

journal_lock:operation_in_progress,

journal_lock:projection_group_not_owned,

journal_provenance:manifest_missing,

journal_provenance:source_missing_for_manifest,

journal_provenance:manifest_missing_for_history,

journal_provenance:authoritative_manifest_requires_provenanced_writer,

journal_provenance:writer_provenance_unavailable,

journal_provenance:writer_provenance_invalid,

journal_provenance:writer_provenance_mismatch,

journal_provenance:journal_identity_changed,

journal_provenance:writer_incarnation_mismatch,

journal_provenance:manifest_tip_mismatch,

journal_provenance:manifest_tip_changed,

journal_provenance:manifest_compare_and_swap_failed,

journal_provenance:identity_provisioning_compare_and_swap_failed,

journal_provenance:source_identity_changed,

journal_provenance:indexed_source_identity_changed,

journal_provenance:snapshot_mismatch,

journal_provenance:manifest_tip_regressed,

journal_provenance:manifest_tip_unanchored,

journal_provenance:manifest_commit_marker_unsafe,

journal_provenance:command_link_profile_mismatch,

journal_provenance:command_link_profile_not_consumed,

journal_provenance:readiness_epoch_mismatch,

journal_data:incomplete_tail,

journal_data:invalid_json,

journal_data:record_schema_invalid,

journal_data:manifest_schema_invalid,

journal_data:manifest_hash_invalid,

journal_data:payload_hash_invalid,

journal_data:record_hash_invalid,

journal_data:hash_chain_invalid,

journal_data:fork_invalid,

journal_data:record_too_large,

journal_data:page_too_large,

journal_data:manifest_too_large,

journal_data:sequence_out_of_range,

journal_data:invalid_command_chain,

journal_data:command_link_profile_invalid,

journal_data:semantic_validation_failed,

journal_data:page_record_count_invalid,

journal_data:page_record_mismatch,

journal_data:page_invalid,

journal_availability:source_unavailable,

journal_availability:manifest_unavailable,

journal_availability:directory_unavailable,

journal_availability:source_changed_during_read,

journal_availability:source_changed_during_page,

journal_availability:manifest_changed_during_read,

journal_availability:writer_state_unavailable,

journal_availability:writer_fenced_after_append_uncertainty,

journal_availability:writer_closed,

journal_availability:invalid_write_progress,

journal_availability:database_unreachable_before_commit,

journal_availability:database_commit_outcome_uncertain,

journal_availability:database_provisioning_failed,

journal_availability:range_unavailable,

journal_availability:source_ended_before_committed_tip,

journal_availability:page_offsets_unavailable,

journal_availability:remote_response_status_invalid,

journal_availability:remote_response_content_type_invalid,

journal_availability:remote_response_too_large,

journal_availability:remote_response_body_invalid,

journal_availability:remote_response_json_invalid,

journal_availability:remote_page_invalid,

journal_availability:remote_request_timeout,

journal_availability:remote_request_failed,

journal_availability:page_build_failed,

journal_projection:not_composed,

journal_projection:run_failed,

journal_projection:not_caught_up,

journal_projection:iteration_in_progress,

journal_projection:consumer_topology_invalid,

journal_projection:source_consumer_missing,

journal_projection:checkpoint_invalid,

journal_projection:checkpoint_binding_failed,

journal_projection:snapshot_mismatch,

journal_projection:consumer_lagging,

journal_projection:cursor_state_missing,

journal_projection:preflight_page_missing,

journal_projection:source_capture_missing,

journal_projection:page_rejected,

journal_projection:page_checkpoint_binding_mismatch,

journal_projection:page_incomplete,

journal_projection:page_group_invalid,

journal_projection:waiting_for_dependency,

journal_projection:source_provenance_missing,

journal_data:private_file_invalid,

journal_provenance:manifest_identity_changed,

journal_availability:local_log_volume_exhausted

engineTransport

object

Show child attributes

cantonOffline

object

Show child attributes

coreTreasury

object

Show child attributes

coreMirror

object

Show child attributes

Account policy

External REST API

Response