Virtual Environment Versions

List Virtual Environment Version Flow Priorities

get

Retrieves a paginated list of flow priorities for a specific virtual environment version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities

HTTPcURLJavaScriptPython

GET /api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 0,
      "virtual_environment_version_id": 0,
      "flow_id": 0,
      "priority": 0,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z"
    }
  ],
  "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 Flow Priority

post

Creates a new flow priority for a specific virtual environment version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

Body

application/json

flow_idstringRequired

priorityintegerRequired

notesstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities

HTTPcURLJavaScriptPython

POST /api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "flow_id": "text",
  "priority": 1,
  "notes": "text"
}

{
  "data": {
    "id": 1,
    "flow_id": 1,
    "priority": 1,
    "model_type": "example_model_type",
    "original_model_id": 1,
    "replacement_model_id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "fallback": "example_fallback",
    "date_format": "example_date_format",
    "secret": "example_secret",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "version": 1,
    "virtual_environment_id": 1,
    "virtual_environment": {},
    "status": "Draft",
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployed_by": [],
    "notes": [],
    "manifests": [],
    "variables": [],
    "counts": "example_counts",
    "user_id": 1,
    "user": {}
  }
}

Update Virtual Environment Version Flow Priority

put

Updates an existing flow priority for a specific virtual environment version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

flow_prioritystringRequired

The flow priority identifier.

Body

application/json

flow_idstringOptional

priorityintegerOptional

notesstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities/{flow_priority}

HTTPcURLJavaScriptPython

PUT /api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities/{flow_priority} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "flow_id": "text",
  "priority": 1,
  "notes": "text"
}

{
  "data": {
    "id": 1,
    "flow_id": 1,
    "priority": 1,
    "model_type": "example_model_type",
    "original_model_id": 1,
    "replacement_model_id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "fallback": "example_fallback",
    "date_format": "example_date_format",
    "secret": "example_secret",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "version": 1,
    "virtual_environment_id": 1,
    "virtual_environment": {},
    "status": "Draft",
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployed_by": [],
    "notes": [],
    "manifests": [],
    "variables": [],
    "counts": "example_counts",
    "user_id": 1,
    "user": {}
  }
}

Delete Virtual Environment Version Flow Priority

delete

Permanently deletes a specific flow priority for a specific virtual environment version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

flow_prioritystringRequired

The flow priority identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities/{flow_priority}

HTTPcURLJavaScriptPython

DELETE /api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities/{flow_priority} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

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

List Virtual Environment Version Manifests

get

Retrieves a paginated list of component replacement rules for a specific virtual environment version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/virtual-environment-versions/{virtual_environment_version}/manifests

HTTPcURLJavaScriptPython

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

{
  "data": [],
  "links": {
    "first": "string",
    "last": "string",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": null,
    "last_page": 1,
    "per_page": 15,
    "to": null,
    "total": 0
  }
}

Create Virtual Environment Version Manifest

post

Creates a new component replacement rule for a specific virtual environment version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

Body

application/json

model_typestringRequired

original_model_idstringRequired

replacement_model_idstringRequired

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/virtual-environment-versions/{virtual_environment_version}/manifests

HTTPcURLJavaScriptPython

POST /api/v1/virtual-environment-versions/{virtual_environment_version}/manifests HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "model_type": "text",
  "original_model_id": "text",
  "replacement_model_id": "text"
}

{
  "data": {
    "id": 1,
    "flow_id": 1,
    "priority": 1,
    "model_type": "example_model_type",
    "original_model_id": 1,
    "replacement_model_id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "fallback": "example_fallback",
    "date_format": "example_date_format",
    "secret": "example_secret",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "version": 1,
    "virtual_environment_id": 1,
    "virtual_environment": {},
    "status": "Draft",
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployed_by": [],
    "notes": [],
    "manifests": [],
    "variables": [],
    "counts": "example_counts",
    "user_id": 1,
    "user": {}
  }
}

Get Virtual Environment Version Manifest

get

Retrieves the details of a specific component replacement rule for a specific virtual environment version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

manifeststringRequired

The manifest identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/virtual-environment-versions/{virtual_environment_version}/manifests/{manifest}

HTTPcURLJavaScriptPython

GET /api/v1/virtual-environment-versions/{virtual_environment_version}/manifests/{manifest} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "flow_id": 1,
    "priority": 1,
    "model_type": "example_model_type",
    "original_model_id": 1,
    "replacement_model_id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "fallback": "example_fallback",
    "date_format": "example_date_format",
    "secret": "example_secret",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "version": 1,
    "virtual_environment_id": 1,
    "virtual_environment": {},
    "status": "Draft",
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployed_by": [],
    "notes": [],
    "manifests": [],
    "variables": [],
    "counts": "example_counts",
    "user_id": 1,
    "user": {}
  }
}

Update Virtual Environment Version Manifest

put

Updates an existing component replacement rule for a specific virtual environment version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

manifeststringRequired

The manifest identifier.

Body

application/json

model_typestringOptional

original_model_idstringOptional

replacement_model_idstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/virtual-environment-versions/{virtual_environment_version}/manifests/{manifest}

HTTPcURLJavaScriptPython

PUT /api/v1/virtual-environment-versions/{virtual_environment_version}/manifests/{manifest} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "model_type": "text",
  "original_model_id": "text",
  "replacement_model_id": "text"
}

{
  "data": {
    "id": 1,
    "flow_id": 1,
    "priority": 1,
    "model_type": "example_model_type",
    "original_model_id": 1,
    "replacement_model_id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "fallback": "example_fallback",
    "date_format": "example_date_format",
    "secret": "example_secret",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "version": 1,
    "virtual_environment_id": 1,
    "virtual_environment": {},
    "status": "Draft",
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployed_by": [],
    "notes": [],
    "manifests": [],
    "variables": [],
    "counts": "example_counts",
    "user_id": 1,
    "user": {}
  }
}

Delete Virtual Environment Version Manifest

delete

Permanently deletes a specific component replacement rule for a specific virtual environment version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

manifeststringRequired

The manifest identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/virtual-environment-versions/{virtual_environment_version}/manifests/{manifest}

HTTPcURLJavaScriptPython

DELETE /api/v1/virtual-environment-versions/{virtual_environment_version}/manifests/{manifest} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

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

List Virtual Environment Version Variables

get

Retrieves a paginated list of variables for a specific virtual environment version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

Query parameters

filter[label]stringOptional

Filter results by label.

filter[key]stringOptional

Filter results by key.

filter[value]stringOptional

Filter results by value.

sortstringOptional

Sort field. Prefix with - for descending. Available: label, key, value

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-environment-versions/{virtual_environment_version}/variables

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "id": 0,
      "virtual_environment_version_id": 0,
      "type": "string",
      "value": "string",
      "fallback": null,
      "key": "string",
      "date_format": null,
      "secret": 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 Variable

post

Creates a new variable for a specific virtual environment version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

Body

application/json

typestringRequired

keystring · min: 1Required

valuestring · max: 1024Optional

fallbackstring · max: 1024 · nullableOptional

date_formatstring · nullableOptional

secretstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/virtual-environment-versions/{virtual_environment_version}/variables

HTTPcURLJavaScriptPython

POST /api/v1/virtual-environment-versions/{virtual_environment_version}/variables HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "type": "text",
  "key": "text",
  "value": "text",
  "fallback": "text",
  "date_format": "text",
  "secret": "text"
}

{
  "data": {
    "id": 1,
    "label": "My Label",
    "key": "example_key",
    "value": "example_value",
    "secret": "example_secret",
    "locked": "example_locked",
    "configurable": "example_configurable",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "modified": "example_modified",
    "pivot": "example_pivot",
    "required": true,
    "advanced": true,
    "alias": "example_alias"
  }
}

Update Virtual Environment Version Variable

put

Updates an existing variable for a specific virtual environment version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

variablestringRequired

The variable identifier.

Body

application/json

typestringOptional

keystring · min: 1Optional

valuestring · max: 1024Optional

fallbackstring · max: 1024 · nullableOptional

date_formatstring · nullableOptional

secretstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/virtual-environment-versions/{virtual_environment_version}/variables/{variable}

HTTPcURLJavaScriptPython

PUT /api/v1/virtual-environment-versions/{virtual_environment_version}/variables/{variable} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "type": "text",
  "key": "text",
  "value": "text",
  "fallback": "text",
  "date_format": "text",
  "secret": "text"
}

{
  "data": {
    "id": 1,
    "label": "My Label",
    "key": "example_key",
    "value": "example_value",
    "secret": "example_secret",
    "locked": "example_locked",
    "configurable": "example_configurable",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "modified": "example_modified",
    "pivot": "example_pivot",
    "required": true,
    "advanced": true,
    "alias": "example_alias"
  }
}

Delete Virtual Environment Version Variable

delete

Permanently deletes a specific variable for a specific virtual environment version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

variablestringRequired

The variable identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/virtual-environment-versions/{virtual_environment_version}/variables/{variable}

HTTPcURLJavaScriptPython

DELETE /api/v1/virtual-environment-versions/{virtual_environment_version}/variables/{variable} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

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