Skip to content


A simulation enters several different states throughout its lifetime. The status of simulation is closely related to actions that are applied to it, see the documentation for the actions endpoint for more details.


The first state of a simulation. Once the resource has been created, this state is linked to it.

Automatic deletion of simulation resource

Simulation resources that remain in the created state (thus the calculation does not take place) for two weeks, will be removed.


Once the simulation starts or is initialized by sending a POST request to the /simulations/{id}/actions/ endpoint, its status becomes starting.


The set will become initialized once all the processes needed for the calculation core to be able to run, have been started and the 3Di calculation core has been initialized.

Ended - Finished

Once the simulation has finished, the state changes to ended. Usually some postprocessing steps are required, such as uploading the result files. Once these steps are done, the simulation enters the state finished and the simulation is complete.


From any state, it is possible that something goes wrong. The simulation then enters the status crashed which is also a final state. In most cases the result files still will be uploaded and therefore will be available for further analysis.

finished and crashed status resources also have an exit_code attribute that gives insight into the application state when the simulation life cycle is over.


List the latest status resource for simulations.

GET /statuses/

from threedi_api_client.api import ThreediApi
from threedi_api_client.versions import V3Api

with ThreediApi() as api_client:
    api_client: V3Api


Ordering options

Fields that can be used to order the results

  • id [default]: numerical identifier, ascending.
  • exit_code: the code the simlation exited with. See exit codes for details

see ordering for general ordering options.

The filtering chapter has some examples of special filter options for this endpoint.