Flow Version Deployments

List Flow Version Deployments

get

Retrieves a paginated list of all flow version deployments. Can be filtered by package_id, virtual_environment_id, name, and other criteria.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Query parameters

filter[package_id]stringOptional

Filter results by package_id.

filter[virtual_environment_id]stringOptional

Filter results by virtual_environment_id.

filter[global]stringOptional

Filter results by global.

filter[flowVersion.flow]stringOptional

Filter results by flowVersion.flow.

filter[name]stringOptional

Filter results by name.

filter[LIKE]stringOptional

Filter results by LIKE.

includestringOptional

Comma-separated list of relationships to include. Available: enabledBy, flowVersion, virtualEnvironment, package, user

sortstringOptional

Sort field. Prefix with - for descending. Available: created_at, enabled_at, flow_name, DESC, ASC, flow_versions, flow_version_deployments.flow_version_id, =, flow_versions.id, flows, flow_versions.flow_id, =, flows.id, flows.name, flow_version_iteration, DESC, ASC, flow_versions.id, ( SELECT COUNT(*) FROM flow_versions fv2 WHERE fv2.flow_id = flow_versions.flow_id AND fv2.id <= flow_versions.id ) AS iteration, flow_versions, flow_versions.id, flow_versions, flow_version_deployments.flow_version_id, =, flow_versions.id, iteration_calc, flow_versions.id, =, iteration_calc.id, iteration_calc.iteration

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

get/api/v1/flow-version-deployments

GET /api/v1/flow-version-deployments HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 0,
      "flow_version_id": 0,
      "flow_version": {
        "id": 0,
        "iteration": 0,
        "deleted_at": null,
        "flow": {
          "id": 0,
          "name": "string",
          "deleted_at": null
        }
      },
      "virtual_environment_id": null,
      "enabled_by": 0,
      "enabled_at": "string",
      "package_id": null,
      "user_id": 0,
      "priority": null,
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 0,
    "from": 0,
    "last_page": 0,
    "path": "string",
    "per_page": 0,
    "to": 0,
    "total": 0
  }
}

List Flow Version Deployments

get

Retrieves a paginated list of all deployments for a specific flow version.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

Query parameters

filter[flow_id]stringOptional

Filter results by flow_id.

filter[package_id]stringOptional

Filter results by package_id.

filter[virtual_environment_id]stringOptional

Filter results by virtual_environment_id.

filter[global]stringOptional

Filter results by global.

includestringOptional

Comma-separated list of relationships to include. Available: enabledBy, flowVersion, virtualEnvironment, package, user

sortstringOptional

Sort field. Prefix with - for descending. Available: flow_name, flow_version_iteration

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get/api/v1/flow-versions/{flow_version}/deployments

GET /api/v1/flow-versions/{flow_version}/deployments HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 0,
      "flow_version_id": 0,
      "virtual_environment_id": null,
      "priority": 0,
      "deploy_disabled": false,
      "enabled_at": null,
      "created_at": "2024-01-01T00:00:00.000000Z",
      "updated_at": "2024-01-01T00:00:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://core.wearepatchworks.com/api/v1/flow-versions/6/deployments",
    "per_page": 15,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://core.wearepatchworks.com/api/v1/flow-versions/6/deployments?page=1",
    "last": "https://core.wearepatchworks.com/api/v1/flow-versions/6/deployments?page=1",
    "prev": null,
    "next": null
  }
}

Create Flow Version Deployment

post

Creates a new deployment for a flow version. Accepts an optional virtual environment and priority level.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

Body

virtual_environment_idstring · nullableOptional

flow_version_idstringRequired

priorityinteger · nullableOptional

deploy_disabledboolean · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/flow-versions/{flow_version}/deployments

POST /api/v1/flow-versions/{flow_version}/deployments HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "flow_version_id": 0,
  "virtual_environment_id": null,
  "priority": 0,
  "deploy_disabled": false
}

{
  "data": {
    "id": 0,
    "flow_version_id": 0,
    "virtual_environment_id": null,
    "priority": 0,
    "deploy_disabled": false,
    "enabled_at": null,
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z"
  }
}

Get Flow Version Deployment

get

Retrieves the details of a specific flow version deployment.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

deploymentstringRequired

The deployment identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get/api/v1/flow-versions/{flow_version}/deployments/{deployment}

GET /api/v1/flow-versions/{flow_version}/deployments/{deployment} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 0,
    "flow_version_id": 0,
    "virtual_environment_id": null,
    "priority": 0,
    "deploy_disabled": false,
    "enabled_at": null,
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z"
  }
}

Update Flow Version Deployment

put

Updates an existing deployment. Accepts a virtual environment, priority, and enabled timestamp.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

deploymentstringRequired

The deployment identifier.

Body

virtual_environment_idstring · nullableOptional

priorityinteger · nullableOptional

enabled_atstring · date-time · nullableOptional

deploy_disabledboolean · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put/api/v1/flow-versions/{flow_version}/deployments/{deployment}

PUT /api/v1/flow-versions/{flow_version}/deployments/{deployment} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "virtual_environment_id": null,
  "priority": 0,
  "deploy_disabled": false,
  "enabled_at": null
}

{
  "data": {
    "id": 0,
    "flow_version_id": 0,
    "virtual_environment_id": null,
    "priority": 0,
    "deploy_disabled": false,
    "enabled_at": null,
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z"
  }
}

Delete Flow Version Deployment

delete

Permanently deletes a specific flow version deployment.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

deploymentstringRequired

The deployment identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete/api/v1/flow-versions/{flow_version}/deployments/{deployment}

DELETE /api/v1/flow-versions/{flow_version}/deployments/{deployment} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "string"
}

Enable Flow Version Deployment

post

Enables a specific flow version deployment, allowing it to process runs.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

deploymentstringRequired

The deployment identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/flow-versions/{flow_version}/deployments/{deployment}/enable

POST /api/v1/flow-versions/{flow_version}/deployments/{deployment}/enable HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "string"
}

Disable Flow Version Deployment

post

Disables a specific flow version deployment, preventing it from processing runs.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

deploymentstringRequired

The deployment identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/flow-versions/{flow_version}/deployments/{deployment}/disable

POST /api/v1/flow-versions/{flow_version}/deployments/{deployment}/disable HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "string"
}