> ## Documentation Index
> Fetch the complete documentation index at: https://docs.domino.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Recreates a previously-run workflow execution that will only start executing

> Recreates a previously-run workflow execution that will only start executing from the last known failure point. In Recover mode, users cannot change any input parameters or update the version of the execution. This is extremely useful to recover from system errors and byzantine faults like - Loss of K8s cluster, bugs in platform or instability, machine failures, downstream system failures (downstream services), or simply to recover executions that failed because of retry exhaustion and should complete if tried again.



## OpenAPI

````yaml /api-specs/cloud/flyte-native-api.yaml post /api/v1/executions/recover
openapi: 3.0.0
info:
  title: flyteidl/service/admin.proto
  version: version not set
servers:
  - url: https://mycluster.domino.tech
    description: >-
      Replace 'mycluster.domino.tech' with your Domino cluster hostname. For
      Domino Cloud customers, that is <your-subdomain>.domino.tech (e.g.,
      acme.domino.tech). For self-hosted deployments, it is the hostname you
      reach the Domino UI at.
security: []
tags:
  - name: AdminService
paths:
  /api/v1/executions/recover:
    post:
      tags:
        - AdminService
      summary: >-
        Recreates a previously-run workflow execution that will only start
        executing
      description: >-
        Recreates a previously-run workflow execution that will only start
        executing from the last known failure point. In Recover mode, users
        cannot change any input parameters or update the version of the
        execution. This is extremely useful to recover from system errors and
        byzantine faults like - Loss of K8s cluster, bugs in platform or
        instability, machine failures, downstream system failures (downstream
        services), or simply to recover executions that failed because of retry
        exhaustion and should complete if tried again.
      operationId: AdminService_RecoverExecution
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/adminExecutionRecoverRequest'
        description: Request to recover the referenced execution.
        required: true
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/adminExecutionCreateResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
components:
  schemas:
    adminExecutionRecoverRequest:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/coreWorkflowExecutionIdentifier'
        name:
          type: string
          title: |-
            User provided value for the recovered execution.
            If none is provided the system will generate a unique string.
            +optional
        metadata:
          $ref: '#/components/schemas/adminExecutionMetadata'
      description: Request to recover the referenced execution.
    adminExecutionCreateResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/coreWorkflowExecutionIdentifier'
      description: >-
        The unique identifier for a successfully created execution.

        If the name was *not* specified in the create request, this identifier
        will include a generated name.
    googlerpcStatus:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/protobufAny'
    coreWorkflowExecutionIdentifier:
      type: object
      properties:
        project:
          type: string
          description: Name of the project the resource belongs to.
        domain:
          type: string
          description: |-
            Name of the domain the resource belongs to.
            A domain can be considered as a subset within a specific project.
        name:
          type: string
          description: User or system provided value for the resource.
        org:
          type: string
          description: Optional, org key applied to the resource.
      title: >-
        Encapsulation of fields that uniquely identifies a Flyte workflow
        execution
    adminExecutionMetadata:
      type: object
      properties:
        mode:
          $ref: '#/components/schemas/adminExecutionMetadataExecutionMode'
        principal:
          type: string
          description: >-
            Identifier of the entity that triggered this execution.

            For systems using back-end authentication any value set here will be
            discarded in favor of the

            authenticated user context.
        nesting:
          type: integer
          format: int64
          description: >-
            Indicates the nestedness of this execution.

            If a user launches a workflow execution, the default nesting is 0.

            If this execution further launches a workflow (child workflow), the
            nesting level is incremented by 0 => 1

            Generally, if workflow at nesting level k launches a workflow then
            the child workflow will have

            nesting = k + 1.
        scheduled_at:
          type: string
          format: date-time
          description: >-
            For scheduled executions, the requested time for execution for this
            specific schedule invocation.
        parent_node_execution:
          $ref: '#/components/schemas/coreNodeExecutionIdentifier'
        reference_execution:
          $ref: '#/components/schemas/coreWorkflowExecutionIdentifier'
        system_metadata:
          $ref: '#/components/schemas/adminSystemMetadata'
        artifact_ids:
          type: array
          items:
            $ref: '#/components/schemas/coreArtifactID'
          description: >-
            Save a list of the artifacts used in this execution for now. This is
            a list only rather than a mapping

            since we don't have a structure to handle nested ones anyways.
      description: >-
        Represents attributes about an execution which are not required to
        launch the execution but are useful to record.

        These attributes are assigned at launch time and do not change.
    protobufAny:
      type: object
      properties:
        '@type':
          type: string
          description: >-
            A URL/resource name that uniquely identifies the type of the
            serialized

            protocol buffer message. This string must contain at least

            one "/" character. The last segment of the URL's path must represent

            the fully qualified name of the type (as in

            `path/google.protobuf.Duration`). The name should be in a canonical
            form

            (e.g., leading "." is not accepted).


            In practice, teams usually precompile into the binary all types that
            they

            expect it to use in the context of Any. However, for URLs which use
            the

            scheme `http`, `https`, or no scheme, one can optionally set up a
            type

            server that maps type URLs to message definitions as follows:


            * If no scheme is provided, `https` is assumed.

            * An HTTP GET on the URL must yield a [google.protobuf.Type][]
              value in binary format, or produce an error.
            * Applications are allowed to cache lookup results based on the
              URL, or have them precompiled into a binary to avoid any
              lookup. Therefore, binary compatibility needs to be preserved
              on changes to types. (Use versioned type names to manage
              breaking changes.)

            Note: this functionality is not currently available in the official

            protobuf release, and it is not used for type URLs beginning with

            type.googleapis.com. As of May 2023, there are no widely used type
            server

            implementations and no plans to implement one.


            Schemes other than `http`, `https` (or the empty scheme) might be

            used with implementation specific semantics.
      additionalProperties: {}
      description: >-
        `Any` contains an arbitrary serialized protocol buffer message along
        with a

        URL that describes the type of the serialized message.


        Protobuf library provides support to pack/unpack Any values in the form

        of utility functions or additional generated methods of the Any type.


        Example 1: Pack and unpack a message in C++.

            Foo foo = ...;
            Any any;
            any.PackFrom(foo);
            ...
            if (any.UnpackTo(&foo)) {
              ...
            }

        Example 2: Pack and unpack a message in Java.

            Foo foo = ...;
            Any any = Any.pack(foo);
            ...
            if (any.is(Foo.class)) {
              foo = any.unpack(Foo.class);
            }
            // or ...
            if (any.isSameTypeAs(Foo.getDefaultInstance())) {
              foo = any.unpack(Foo.getDefaultInstance());
            }

         Example 3: Pack and unpack a message in Python.

            foo = Foo(...)
            any = Any()
            any.Pack(foo)
            ...
            if any.Is(Foo.DESCRIPTOR):
              any.Unpack(foo)
              ...

         Example 4: Pack and unpack a message in Go

             foo := &pb.Foo{...}
             any, err := anypb.New(foo)
             if err != nil {
               ...
             }
             ...
             foo := &pb.Foo{}
             if err := any.UnmarshalTo(foo); err != nil {
               ...
             }

        The pack methods provided by protobuf library will by default use

        'type.googleapis.com/full.type.name' as the type URL and the unpack

        methods only use the fully qualified type name after the last '/'

        in the type URL, for example "foo.bar.com/x/y.z" will yield type

        name "y.z".


        JSON

        ====

        The JSON representation of an `Any` value uses the regular

        representation of the deserialized, embedded message, with an

        additional field `@type` which contains the type URL. Example:

            package google.profile;
            message Person {
              string first_name = 1;
              string last_name = 2;
            }

            {
              "@type": "type.googleapis.com/google.profile.Person",
              "firstName": <string>,
              "lastName": <string>
            }

        If the embedded message type is well-known and has a custom JSON

        representation, that representation will be embedded adding a field

        `value` which holds the custom JSON in addition to the `@type`

        field. Example (for message [google.protobuf.Duration][]):

            {
              "@type": "type.googleapis.com/google.protobuf.Duration",
              "value": "1.212s"
            }
    adminExecutionMetadataExecutionMode:
      type: string
      enum:
        - MANUAL
        - SCHEDULED
        - SYSTEM
        - RELAUNCH
        - CHILD_WORKFLOW
        - RECOVERED
        - TRIGGER
      default: MANUAL
      description: |-
        The method by which this execution was launched.

         - MANUAL: The default execution mode, MANUAL implies that an execution was launched by an individual.
         - SCHEDULED: A schedule triggered this execution launch.
         - SYSTEM: A system process was responsible for launching this execution rather an individual.
         - RELAUNCH: This execution was launched with identical inputs as a previous execution.
         - CHILD_WORKFLOW: This execution was triggered by another execution.
         - RECOVERED: This execution was recovered from another execution.
         - TRIGGER: Execution was kicked off by the artifact trigger system
    coreNodeExecutionIdentifier:
      type: object
      properties:
        node_id:
          type: string
        execution_id:
          $ref: '#/components/schemas/coreWorkflowExecutionIdentifier'
      description: Encapsulation of fields that identify a Flyte node execution entity.
    adminSystemMetadata:
      type: object
      properties:
        execution_cluster:
          type: string
          description: Which execution cluster this execution ran on.
        namespace:
          type: string
          description: Which kubernetes namespace the execution ran under.
      description: Represents system, rather than user-facing, metadata about an execution.
    coreArtifactID:
      type: object
      properties:
        artifact_key:
          $ref: '#/components/schemas/coreArtifactKey'
        version:
          type: string
        partitions:
          $ref: '#/components/schemas/corePartitions'
        time_partition:
          $ref: '#/components/schemas/coreTimePartition'
    coreArtifactKey:
      type: object
      properties:
        project:
          type: string
          description: >-
            Project and domain and suffix needs to be unique across a given
            artifact store.
        domain:
          type: string
        name:
          type: string
        org:
          type: string
    corePartitions:
      type: object
      properties:
        value:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/coreLabelValue'
    coreTimePartition:
      type: object
      properties:
        value:
          $ref: '#/components/schemas/coreLabelValue'
        granularity:
          $ref: '#/components/schemas/coreGranularity'
    coreLabelValue:
      type: object
      properties:
        static_value:
          type: string
          title: The string static value is for use in the Partitions object
        time_value:
          type: string
          format: date-time
          title: The time value is for use in the TimePartition case
        triggered_binding:
          $ref: '#/components/schemas/coreArtifactBindingData'
        input_binding:
          $ref: '#/components/schemas/coreInputBindingData'
        runtime_binding:
          $ref: '#/components/schemas/coreRuntimeBinding'
    coreGranularity:
      type: string
      enum:
        - UNSET
        - MINUTE
        - HOUR
        - DAY
        - MONTH
      default: UNSET
      title: '- DAY: default'
    coreArtifactBindingData:
      type: object
      properties:
        partition_key:
          type: string
        bind_to_time_partition:
          type: boolean
        time_transform:
          $ref: '#/components/schemas/coreTimeTransform'
      title: Only valid for triggers
    coreInputBindingData:
      type: object
      properties:
        var:
          type: string
    coreRuntimeBinding:
      type: object
    coreTimeTransform:
      type: object
      properties:
        transform:
          type: string
        op:
          $ref: '#/components/schemas/flyteidlcoreOperator'
    flyteidlcoreOperator:
      type: string
      enum:
        - MINUS
        - PLUS
      default: MINUS

````