---
title: "POST /flows/instances/"
method: POST
path: "/flows/instances/"
tags: ["flows"]
---

# POST /flows/instances/

`POST /flows/instances/`

Flow Viewset

## Request body

- FlowRequest — Flow Serializer
  - `name` string, required
  - `slug` string, required — Visible in the URL.
  - `title` string, required — Shown as the Title in Flow pages.
  - `designation` 'authentication' | 'authorization' | 'invalidation' | 'enrollment' | 'unenrollment' | 'recovery' | 'stage_configuration', required
  - `background` string — Background shown during execution
  - `policy_engine_mode` 'all' | 'any'
  - `compatibility_mode` boolean — Enable compatibility mode, increases compatibility with password managers on mobile devices.
  - `layout` 'stacked' | 'content_left' | 'content_right' | 'sidebar_left' | 'sidebar_right' | 'sidebar_left_frame_background' | 'sidebar_right_frame_background'
  - `denied_action` 'message_continue' | 'message' | 'continue'
  - `authentication` 'none' | 'require_authenticated' | 'require_unauthenticated' | 'require_superuser' | 'require_redirect' | 'require_outpost' | 'require_token'

## Response `201`

- Flow — Flow Serializer
  - `pk` string, uuid, required
  - `policybindingmodel_ptr_id` string, uuid, required
  - `name` string, required
  - `slug` string, required — Visible in the URL.
  - `title` string, required — Shown as the Title in Flow pages.
  - `designation` 'authentication' | 'authorization' | 'invalidation' | 'enrollment' | 'unenrollment' | 'recovery' | 'stage_configuration', required
  - `background` string — Background shown during execution
  - `background_url` string, required — Get the URL to the background image
  - `background_themed_urls` ThemedUrls, required — Themed URLs - maps theme names to URLs for light and dark themes
    - `light` string, nullable
    - `dark` string, nullable
  - `stages` string[], required
  - `policies` string[], required
  - `cache_count` integer, required — Get count of cached flows
  - `policy_engine_mode` 'all' | 'any'
  - `compatibility_mode` boolean — Enable compatibility mode, increases compatibility with password managers on mobile devices.
  - `export_url` string, required — Get export URL for flow
  - `layout` 'stacked' | 'content_left' | 'content_right' | 'sidebar_left' | 'sidebar_right' | 'sidebar_left_frame_background' | 'sidebar_right_frame_background'
  - `denied_action` 'message_continue' | 'message' | 'continue'
  - `authentication` 'none' | 'require_authenticated' | 'require_unauthenticated' | 'require_superuser' | 'require_redirect' | 'require_outpost' | 'require_token'

## Other responses

- `400`
- `403`

---

[API](https://skmtc.dev/goauthentik/apis/authentik.md) · [All operations](https://skmtc.dev/goauthentik/apis/authentik/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/goauthentik/authentik/revisions/4e42e86021d7/schema)