Skip to main content

Add deployment to flow

POST /v1/flow/{id}/add-deployment

Adds a new deployment to an existing flow using a specific package. Returns the ID of the created deployment. Deployment may optionally be started after creation if the 'startNow' property is set.

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​

NameInRequiredTypeNullableConstraints / defaultDescription
idpathYesstring (uuid)Not declared—ID of target deployment flow.

Parameter names and capitalization follow the source definition. Required status follows the parameter's explicit required flag; optional does not imply a server default.

Request body​

Required: Yes.

Request media type: application/*+json​

Type: V1FlowAddDeploymentViewModel

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

Request media type: application/json​

Type: V1FlowAddDeploymentViewModel

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

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

Type: V1FlowAddDeploymentViewModel

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

Request media type: text/json​

Type: V1FlowAddDeploymentViewModel

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 and set ID to the target values. 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/${ID}/add-deployment" \
  --header "X-API-Key: ${ROBOPACK_API_KEY}" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data-binary '@request.json'

Complete operation definition​

{
  "description": "Adds a new deployment to an existing flow using a specific package. Returns the ID of the created deployment. Deployment may optionally be started after creation if the 'startNow' property is set.",
  "parameters": [
    {
      "description": "ID of target deployment flow.",
      "in": "path",
      "name": "id",
      "required": true,
      "schema": {
        "format": "uuid",
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/*+json": {
        "schema": {
          "$ref": "#/components/schemas/V1FlowAddDeploymentViewModel"
        }
      },
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/V1FlowAddDeploymentViewModel"
        }
      },
      "application/json-patch+json": {
        "schema": {
          "$ref": "#/components/schemas/V1FlowAddDeploymentViewModel"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/V1FlowAddDeploymentViewModel"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "format": "uuid",
            "type": "string"
          }
        }
      },
      "description": "OK"
    }
  },
  "summary": "Add deployment to flow.",
  "tags": [
    "Flow"
  ]
}