Skip to main content

Create deployment flow

POST /v1/flow/create

Creates a new deployment flow. If a patch group ID is specified, the flow will inherit the waves and settings specified in the patch group. Otherwise the created flow will be empty. Returns the ID of the created flow.

Source: Robopack public API v1 OpenAPI definition · OpenAPI 3.0.1 · Snapshot: 2026-10-01. Download this snapshot.

Servers​

  • https://api.robopack.com/

Authentication​

SchemeTypeLocationNameDescription
API keyapiKeyheaderX-API-KeyRobopack API key generated for account

Send your API key in the X-API-Key header. Examples read it from ROBOPACK_API_KEY.

Parameters​

No path, query, header, or cookie parameters are declared.

Request body​

Required: Yes.

Request media type: application/*+json​

Type: V1FlowCreateViewModel

Follow the model link for its complete properties, enum values, and schema definition.

Request media type: application/json​

Type: V1FlowCreateViewModel

Follow the model link for its complete properties, enum values, and schema definition.

Request media type: application/json-patch+json​

Type: V1FlowCreateViewModel

Follow the model link for its complete properties, enum values, and schema definition.

Request media type: text/json​

Type: V1FlowCreateViewModel

Follow the model link for its complete properties, enum values, and schema definition.

Responses​

200 response​

OK

Response media type: application/json​

Type: string (uuid)

Only response statuses declared in the snapshot are listed. The source does not define a complete error contract.

curl example​

Mutation example: this POST request can change Robopack or Intune state. Review the operation and target identifiers before running it. Set ROBOPACK_API_KEY in your shell. Query values must be URL encoded. Optional query parameters are omitted.

Prepare request.json using the request schema above. The example does not supply or infer property defaults.

curl --request POST \
  --url "https://api.robopack.com/v1/flow/create" \
  --header "X-API-Key: ${ROBOPACK_API_KEY}" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data-binary '@request.json'

Complete operation definition​

{
  "description": "Creates a new deployment flow. If a patch group ID is specified, the flow will inherit the waves and settings specified in the patch group. Otherwise the created flow will be empty. Returns the ID of the created flow.",
  "requestBody": {
    "content": {
      "application/*+json": {
        "schema": {
          "$ref": "#/components/schemas/V1FlowCreateViewModel"
        }
      },
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/V1FlowCreateViewModel"
        }
      },
      "application/json-patch+json": {
        "schema": {
          "$ref": "#/components/schemas/V1FlowCreateViewModel"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/V1FlowCreateViewModel"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "format": "uuid",
            "type": "string"
          }
        }
      },
      "description": "OK"
    }
  },
  "summary": "Create deployment flow.",
  "tags": [
    "Flow"
  ]
}