Virtual Environments | API Reference (WIP)

Index

get

Pagination

Pagination is available for this request. Please see the section on using pagination for more details.

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

versions
versions_count
versionsExists
firstVersion
firstVersion_count
firstVersionExists
firstVersion.user
deployments
deployments_count
deploymentsExists
deployments.flowVersion
deployments.flowVersion.flow
deployments.enabledBy
deployments.user
deployments.package
packageDeployments
packageDeployments_count
packageDeploymentsExists
packageDeployments.user
packageDeployments.package

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

name
type
status
hasDeployedVersion

Available Fields

These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.

virtual_environments.id
virtual_environments.name
virtual_environments.description
virtual_environments.type
virtual_environments.created_at
virtual_environments.updated_at

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

name

Authorizations

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 labelled.

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

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

{
  "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": []
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/virtual-environments",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/virtual-environments?page=1",
    "last": "https://api.example.com/api/v1/virtual-environments?page=1",
    "prev": null,
    "next": null
  }
}

Store

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

name

string

☑

description

string

type

Authorizations

Body

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

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

{
  "description": "A description of the resource",
  "type": "example_type",
  "name": "My Example",
  "labels": []
}

{
  "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": []
  }
}

Show

get

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

versions
versions_count
versionsExists
firstVersion
firstVersion_count
firstVersionExists
firstVersion.user
deployments
deployments_count
deploymentsExists
deployments.flowVersion
deployments.flowVersion.flow
deployments.enabledBy
deployments.user
deployments.package
packageDeployments
packageDeployments_count
packageDeploymentsExists
packageDeployments.user
packageDeployments.package

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

name
type
status
hasDeployedVersion

Available Fields

These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.

virtual_environments.id
virtual_environments.name
virtual_environments.description
virtual_environments.type
virtual_environments.created_at
virtual_environments.updated_at

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

name

Authorizations

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 labelled.

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}

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

{
  "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": []
  }
}

Update

put

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

name

string

☑

description

string

type

Authorizations

Path parameters

virtual_environmentstringRequired

The virtual environment identifier.

Body

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}

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

{
  "description": "A description of the resource",
  "type": "example_type",
  "name": "My Example",
  "labels": []
}

{
  "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": []
  }
}

Destroy

delete

Delete a virtual environment.

Authorizations

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}

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

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

Copy

post

Copy for copy.

Authorizations

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

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

{}

Index

get

Pagination

Pagination is available for this request. Please see the section on using pagination for more details.

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

virtualEnvironment
virtualEnvironment_count
virtualEnvironmentExists

Available Fields

These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.

virtual_environment_versions.id
virtual_environment_versions.notes
virtual_environment_versions.deployed_at
virtual_environment_versions.created_at
virtual_environment_versions.updated_at

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

id
created_at

Authorizations

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

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

{
  "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": []
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/virtual-environments/{virtual_environment}/versions",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/virtual-environments/{virtual_environment}/versions?page=1",
    "last": "https://api.example.com/api/v1/virtual-environments/{virtual_environment}/versions?page=1",
    "prev": null,
    "next": null
  }
}

Store

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

notes

string

Authorizations

Path parameters

virtual_environmentstringRequired

The virtual environment identifier.

Body

notesstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

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

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

{
  "notes": "example_notes"
}

{
  "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": []
  }
}

Show

get

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

virtualEnvironment
virtualEnvironment_count
virtualEnvironmentExists

Available Fields

These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.

virtual_environment_versions.id
virtual_environment_versions.notes
virtual_environment_versions.deployed_at
virtual_environment_versions.created_at
virtual_environment_versions.updated_at

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

id
created_at

Authorizations

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}

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

{
  "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": []
  }
}

Update

put

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

notes

string

Authorizations

Path parameters

virtual_environmentstringRequired

The virtual environment identifier.

versionstringRequired

The version identifier.

Body

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}

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

{
  "notes": "example_notes"
}

{
  "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": []
  }
}

Destroy

delete

Delete a version.

Authorizations

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}

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

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

Copy

post

Copy for copy.

Authorizations

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

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

{}

Deploy

post

Deploy for deploy.

Authorizations

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

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

{}

hashtagIndex

hashtagPagination

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Fields

hashtagAvailable Sorts

hashtagStore

hashtagValidation Rules

hashtagShow

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Fields

hashtagAvailable Sorts

hashtagUpdate

hashtagValidation Rules

hashtagDestroy

hashtagCopy

hashtagIndex

hashtagPagination

hashtagAvailable Includes

hashtagAvailable Fields

hashtagAvailable Sorts

hashtagStore

hashtagValidation Rules

hashtagShow

hashtagAvailable Includes

hashtagAvailable Fields

hashtagAvailable Sorts

hashtagUpdate

hashtagValidation Rules

hashtagDestroy

hashtagCopy

hashtagDeploy

Index

Pagination

Available Includes

Available Filters

Available Fields

Available Sorts

Store

Validation Rules

Show

Available Includes

Available Filters

Available Fields

Available Sorts

Update

Validation Rules

Destroy

Copy

Index

Pagination

Available Includes

Available Fields

Available Sorts

Store

Validation Rules

Show

Available Includes

Available Fields

Available Sorts

Update

Validation Rules

Destroy

Copy

Deploy