--- id: flows-inspector-get title: "flows_inspector_get" description: "Get current flow state and record it" sidebar_label: "flows_inspector_get" hide_title: true hide_table_of_contents: true api: eJztHGlv4zb2rxDCAu1iHTvNpO1sPjU745k1MBcSd3fbaSrQ0rPFWiJVksoxgf973yMpW7Kdq7sDdFF+GEQH331TY94mqgbNrVBykicnybxUVyYV0tSQWaXTBdhkkORgMi1qWoVrXoNlWaM1SMtoPTOWW2Bc5kxDpnTOBAHVXPMKLGiTnHy8TQSB1twW+Erii0AsNWWzwEcmK6DiycltYm9qemmsFnKRrAaJhl8boQHZs7qB1cUgsXxBSD23CT4wgAwJe+Mo8cYWyJtY4t0FLddgaiUNGEJ/dHhIfzIlLS6iS17XpcicDka/GBLxdpcdNfsFNbKji3PQgpfiE2g2V5oFxTGQea2EdGrQpGErPPW65NJ00HKt+Q2uEhYq82RyXDKeWXEJ7BVq4gPi3iEYDJWijRbgpC3L93Onp/tJEcZzAvqHkDlagm1o70q13DXcIEEOK44aTppG5AmZgefvZXnj7YhWFLYkgFdmxtwStHWt0BQ3M0+yUjmUaW11ii+fTGBFfqLJgR8ExaVr/TxuZYpae4o2nSY/nwo9+pZDH157IilTFQZCcPttWrtB7mVhtJAZxWzBLbsCtpQY8wX+s4pBLnBBAWwt944RLkHPlIF0P1fbdM/ANloGdF8Y1oN+AHtal43m5dOJeLgHaWE246l3yicJg4kAtEQCDpbdhd6nw56/PjU9IBt1DTnL1ZUMufmzRS1h/zxhe6f/ulrxoNb/JYyYlYBqd575/dmbIa6p+PUbkAusPydfH1J1smQUXP7zxwN+8On04MfDg7+nF3/7CxEKQj5E6bwgPXPj6EwJhog6zdQYkGZIuBBELCT3IN2MAbKpqIq19cqXICRCD5QWn9p7IS/RhHl7C1KrsqzAlZdG9m6pAKMbk8/4PIV1bi4WjS/xVCq3Jera8+WG1TExR8WzL/FLyAQ+YVeUC2whjJcW/zYG/Q5NO2SvsDLBNa/qEgZOM6c9Ab1fIgSWdCzrlGAU4gNJ5ayRBx11IEZEq9klWtQati7sTq8zni0XWjVyr5PtZrPgC0SNLjfgTFSoqSGbzN0L8j5ib0RtjcgYSoNXGulfCVuwwtr6J4lZz0lA8Y1ccnMgzD5X9oGRouMJCS53ELNry5clmVve3GeYDw7F2GF4SwhCIkfmZqLEpmeNNmCYKVWCawX6ShhLTmHRg3UpaYBemyHr2CFtvXUS19yYK2rrKi5RUdowNGKlcAmwHC5FFhwdrmulbdroR2RgMohf72xCzQy5xT4VlvxGNbarNjRHtgRKHaGLS0uY286tFouC7g366ozr9nV7618/EAtvHFkfBsS9FJCn1G3dFcYVGBMizgrZUIoPjwJn7uE9VF86GqfZPeH3IkQz+AA0hWrKnBXYwWL4+Bjy4eX4xYjJ0DiGXJ67SEI79Rrqj90o6qeqnj1DTh5Qzbgv24cU3cp00VfpOda21TYDm55kt8D2yW6V532V/2KrJUp8+7/lUYDptMHskiqZUkP+mNgJIMzJTqrNGzKfyxg+4SMiSU+wyJLSh350SdfEWsjfRc3Zlmj5Tg9zT41TDU1gIZ0F6w4SDFSs9Rsa1HwsXPXHCigq8tWjr46/PX7+7Jvjb/GhkP7hwfrp88+Xt0IlS9uJ7N6AwuzqChkupvy7uUopLbk4g+t743jiyZ0Fao8MLdfaokpdIME1jpaWakAbazIvadhlQRbWyuKjLCtQEFQb1pOz8fTsh1AjfIsAWiOmkBXcwMyZEZUoud4AthZtKROi8+np2ZQF8c2Gu7lWla9mgGom9xs4tAEi/fdk+s/0xft30/F/9oFfFZTDlwB168rtXB+Uu5svvHs9JhFYn/k249J6HttOC50pc3/ASmTFRSrW2jjJxkk2TrJxko2TbJxk4yQbJ9k4ycZJNk6ycZKNk2ycZP/4kyzF1tree7pgnuMYgmbk5Yduh7u6qw0gfF+YVsgBMxwLOvbIe7tRrIoGwe9oZncJYKaV4tcGRyYPyCYvd9FuJ8He9+a9o/uWFnp8bSl00v5HBPdtm2i1+LeyXfxeHncZ4i5D3GWIuwxxlyHuMsRdhrjLEHcZ4i5D3GWIuwxxl+HPt8sQv5fHSTZOsnGSjZNsnGTjJBsn2TjJxkk2TrJxko2TbJxk/78m2fi9/L/5Xo5hZ1JKsyVYyPekn21uessH4dfq+2mQ2C6l9/VARI/9T+z7L94p73mEk3rlIMTQAzxz397/N7/Jfw0SR5+MnX6YsDHF3c78k2O1EXt6Fddf9Tqq9sWWngKCjmYCUU9vr178GFkoOmbBH6vgTkM4SUbuGIPR+tCF0e36YITVyJlbX7anKLgWKxnxWowun41czLRnH5yTerx8nRMQ1pJQ95qEcxacCwDXoB1bQs6VWxlk2YC7Wmu8BEeHR8fD58OjHX2/5UtKIv1hhrIb+tEwdECY7V0ZqZzekwLKUn23UJu+XijSPtocMKHS0nBGxNvJlGYdJzaJYE5GowUWgWY2RE8ddVCMNlezUs1GSEqO3kxejN+dj52YtTK28jW/cwCFYWvFsz2nXXS88rEHXwSFU7CO0NuFC8TQG3uTtydXkOoDbbw+6Z6HQb5VIMO0+PZ2hh3697pcregxZhhNJ13g5SXHGX9GRkPfyIWha/SvOS8N3CPIl2fBl//K7uK33YaQVIepKaE7vFzCTdI9uWN1gYsLTHHUeiAT/v0pdp+17UDuxDN57jocXo+nYfjt5ijvoIP2orPV1ucK1eNWTNUSJKqoZdLSPTG4Wv0G+jkzvA== sidebar_class_name: "get api-method" info_path: docs/developer-docs/api/reference/authentik custom_edit_url: null hide_send_button: true --- import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; import Heading from "@theme/Heading"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; Get current flow state and record it

Path Parameters

Schema
    plans object[] required
  • Array [
  • current_stage object required
    FlowStageBinding Serializer
    stage_obj object required
    Stage Serializer
    flow_set object[]
  • Array [
  • ]
  • = -2147483648` and `<= 2147483647`"} schema={{"type":"integer","maximum":2147483647,"minimum":-2147483648}} >
    next_planned_stage object required
    FlowStageBinding Serializer
    stage_obj object required
    Stage Serializer
    flow_set object[]
  • Array [
  • ]
  • = -2147483648` and `<= 2147483647`"} schema={{"type":"integer","maximum":2147483647,"minimum":-2147483648}} >
    plan_context object required
    Get the plan's context, sanitized
  • ]
  • current_plan object
    Serializer for an active FlowPlan
    current_stage object required
    FlowStageBinding Serializer
    stage_obj object required
    Stage Serializer
    flow_set object[]
  • Array [
  • ]
  • = -2147483648` and `<= 2147483647`"} schema={{"type":"integer","maximum":2147483647,"minimum":-2147483648}} >
    next_planned_stage object required
    FlowStageBinding Serializer
    stage_obj object required
    Stage Serializer
    flow_set object[]
  • Array [
  • ]
  • = -2147483648` and `<= 2147483647`"} schema={{"type":"integer","maximum":2147483647,"minimum":-2147483648}} >
    plan_context object required
    Get the plan's context, sanitized
No flow plan in session.
Schema