Virtual Environments

Get Virtual Environments

get

Retrieves a list of virtual environments that have at least one flow version deployment. Can be filtered by name, type, status, hasDeployedVersion, and labelled.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Query parameters

filter[name]stringOptional

Filter results by name.

filter[type]stringOptional

Filter results by type.

filter[status]stringOptional

Filter results by status.

filter[hasDeployedVersion]stringOptional

Filter results by hasDeployedVersion.

filter[labelled]stringOptional

Filter results by label id.

includestringOptional

Comma-separated list of relationships to include. Available: versions, firstVersion, firstVersion.user, deployments, deployedVersion.variables, deployments.flowVersion, deployments.flowVersion.flow, deployments.enabledBy, deployments.user, deployments.package, packageDeployments.user, packageDeployments.package, labels

sortstringOptional

Sort field. Prefix with - for descending. Available: name

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/virtual-environments

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "deleted_at": null
    }
  ]
}

List Virtual Environments

get

Retrieves a paginated list of virtual environments.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Query parameters

filter[name]stringOptional

Filter results by name.

filter[type]stringOptional

Filter results by type.

filter[status]stringOptional

Filter results by status.

filter[hasDeployedVersion]stringOptional

Filter results by hasDeployedVersion.

filter[labelled]stringOptional

Filter results by label id.

includestringOptional

Comma-separated list of relationships to include. Available: versions, firstVersion, firstVersion.user, deployments, deployedVersion.variables, deployments.flowVersion, deployments.flowVersion.flow, deployments.enabledBy, deployments.user, deployments.package, packageDeployments.user, packageDeployments.package, labels

sortstringOptional

Sort field. Prefix with - for descending. Available: name

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/virtual-environments

HTTPcURLJavaScriptPython

GET /api/v1/virtual-environments HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "type": "string",
      "flows": [],
      "is_deployed": true,
      "created_at": "string"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 0,
    "from": 0,
    "last_page": 0,
    "links": [],
    "path": "string",
    "per_page": 0,
    "to": 0,
    "total": 0
  }
}

Create Virtual Environment

post

Creates a new virtual environment.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Body

application/json

descriptionstring · max: 255 · nullableOptional

typestring · nullableOptional

namestring · max: 245Required

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/virtual-environments

HTTPcURLJavaScriptPython

POST /api/v1/virtual-environments HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "description": "text",
  "type": "text",
  "name": "text",
  "labels": {
    "*": {
      "id": "text"
    }
  }
}

{
  "data": {
    "id": 1,
    "notes": "example_notes",
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example",
    "description": "A description of the resource",
    "type": "example_type",
    "deployments": [],
    "versions": [],
    "versions_count": 5,
    "first_version": "example_first_version",
    "deployed_version": "example_deployed_version",
    "flows": "example_flows",
    "is_deployed": true,
    "deployments_count": 5,
    "pivot": [],
    "package_deployments": [],
    "labels": []
  }
}

Get Virtual Environment

get

Retrieves the details of a specific virtual environment.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environmentstringRequired

The virtual environment identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

filter[type]stringOptional

Filter results by type.

filter[status]stringOptional

Filter results by status.

filter[hasDeployedVersion]stringOptional

Filter results by hasDeployedVersion.

filter[labelled]stringOptional

Filter results by label id.

includestringOptional

Comma-separated list of relationships to include. Available: versions, firstVersion, firstVersion.user, deployments, deployedVersion.variables, deployments.flowVersion, deployments.flowVersion.flow, deployments.enabledBy, deployments.user, deployments.package, packageDeployments.user, packageDeployments.package, labels

sortstringOptional

Sort field. Prefix with - for descending. Available: name

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/virtual-environments/{virtual_environment}

HTTPcURLJavaScriptPython

GET /api/v1/virtual-environments/{virtual_environment} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": "string",
    "flows": [],
    "is_deployed": false,
    "created_at": "2025-01-15T10:30:00.000000Z"
  }
}

Update Virtual Environment

put

Updates an existing virtual environment.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environmentstringRequired

The virtual environment identifier.

Body

application/json

descriptionstring · max: 255 · nullableOptional

typestring · nullableOptional

namestring · max: 255Required

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/virtual-environments/{virtual_environment}

HTTPcURLJavaScriptPython

PUT /api/v1/virtual-environments/{virtual_environment} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "description": "text",
  "type": "text",
  "name": "text",
  "labels": {
    "*": {
      "id": "text"
    }
  }
}

{
  "data": {
    "id": 1,
    "notes": "example_notes",
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example",
    "description": "A description of the resource",
    "type": "example_type",
    "deployments": [],
    "versions": [],
    "versions_count": 5,
    "first_version": "example_first_version",
    "deployed_version": "example_deployed_version",
    "flows": "example_flows",
    "is_deployed": true,
    "deployments_count": 5,
    "pivot": [],
    "package_deployments": [],
    "labels": []
  }
}

Delete Virtual Environment

delete

Permanently deletes a specific virtual environment.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environmentstringRequired

The virtual environment identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/virtual-environments/{virtual_environment}

HTTPcURLJavaScriptPython

DELETE /api/v1/virtual-environments/{virtual_environment} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "Action completed successfully."
}

Copy Virtual Environment

post

Creates a copy of a specific virtual environment.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environmentstringRequired

The virtual environment identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/virtual-environments/{virtual_environment}/copy

HTTPcURLJavaScriptPython

POST /api/v1/virtual-environments/{virtual_environment}/copy HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{}

List Virtual Environment Versions

get

Retrieves a paginated list of versions for a specific virtual environment.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environmentstringRequired

The virtual environment identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/virtual-environments/{virtual_environment}/versions

HTTPcURLJavaScriptPython

GET /api/v1/virtual-environments/{virtual_environment}/versions HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 0,
      "version": 0,
      "virtual_environment_id": 0,
      "status": "string",
      "deployed_at": null,
      "notes": null,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "user_id": 0
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}

Create Virtual Environment Version

post

Creates a new version for a specific virtual environment.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environmentstringRequired

The virtual environment identifier.

Body

application/json

notesstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/virtual-environments/{virtual_environment}/versions

HTTPcURLJavaScriptPython

POST /api/v1/virtual-environments/{virtual_environment}/versions HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "notes": "text"
}

{
  "data": {
    "id": 1,
    "notes": "example_notes",
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example",
    "description": "A description of the resource",
    "type": "example_type",
    "deployments": [],
    "versions": [],
    "versions_count": 5,
    "first_version": "example_first_version",
    "deployed_version": "example_deployed_version",
    "flows": "example_flows",
    "is_deployed": true,
    "deployments_count": 5,
    "pivot": [],
    "package_deployments": [],
    "labels": []
  }
}

Get Virtual Environment Version

get

Retrieves the details of a specific version for a specific virtual environment.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environmentstringRequired

The virtual environment identifier.

versionstringRequired

The version identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/virtual-environments/{virtual_environment}/versions/{version}

HTTPcURLJavaScriptPython

GET /api/v1/virtual-environments/{virtual_environment}/versions/{version} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 0,
    "version": 0,
    "virtual_environment_id": 0,
    "status": "string",
    "deployed_at": null,
    "notes": null,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "user_id": 0
  }
}

Update Virtual Environment Version

put

Updates an existing version for a specific virtual environment.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environmentstringRequired

The virtual environment identifier.

versionstringRequired

The version identifier.

Body

application/json

notesstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/virtual-environments/{virtual_environment}/versions/{version}

HTTPcURLJavaScriptPython

PUT /api/v1/virtual-environments/{virtual_environment}/versions/{version} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "notes": "text"
}

{
  "data": {
    "id": 1,
    "notes": "example_notes",
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example",
    "description": "A description of the resource",
    "type": "example_type",
    "deployments": [],
    "versions": [],
    "versions_count": 5,
    "first_version": "example_first_version",
    "deployed_version": "example_deployed_version",
    "flows": "example_flows",
    "is_deployed": true,
    "deployments_count": 5,
    "pivot": [],
    "package_deployments": [],
    "labels": []
  }
}

Delete Virtual Environment Version

delete

Permanently deletes a specific version for a specific virtual environment.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environmentstringRequired

The virtual environment identifier.

versionstringRequired

The version identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/virtual-environments/{virtual_environment}/versions/{version}

HTTPcURLJavaScriptPython

DELETE /api/v1/virtual-environments/{virtual_environment}/versions/{version} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "Action completed successfully."
}

Copy Virtual Environment Version

post

Creates a copy of a specific version for a specific virtual environment.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environmentstringRequired

The virtual environment identifier.

versionstringRequired

The version identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/virtual-environments/{virtual_environment}/versions/{version}/copy

HTTPcURLJavaScriptPython

POST /api/v1/virtual-environments/{virtual_environment}/versions/{version}/copy HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{}

Deploy Virtual Environment Version

post

Deploys a specific version of a specific virtual environment.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environmentstringRequired

The virtual environment identifier.

versionstringRequired

The version identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/virtual-environments/{virtual_environment}/versions/{version}/deploy

HTTPcURLJavaScriptPython

POST /api/v1/virtual-environments/{virtual_environment}/versions/{version}/deploy HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{}