> For the complete documentation index, see [llms.txt](https://doc.wearepatchworks.com/product-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.wearepatchworks.com/product-documentation/api-reference/virtual-environments-and-packages/virtual-environment-versions.md). # Virtual Environment Versions ## List Virtual Environment Version Flow Priorities > Retrieves a paginated list of flow priorities for a specific virtual environment version. ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Virtual Environment Versions"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"VirtualEnvironmentVersionsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VirtualEnvironmentVersions"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"VirtualEnvironmentVersions":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"flow_id":{"type":"string"},"priority":{"type":"integer"},"model_type":{"type":"string"},"original_model_id":{"type":"string"},"replacement_model_id":{"type":"string"},"type":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"fallback":{"type":"string"},"date_format":{"type":"string"},"secret":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"version":{"type":"object"},"virtual_environment_id":{"type":"object"},"virtual_environment":{"type":"object"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"deployed_at":{"type":"array","items":{"type":"object"},"format":"date-time"},"deployed_by":{"type":"array","items":{"type":"object"}},"notes":{"type":"array","items":{"type":"object"}},"manifests":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"counts":{"type":"string"},"user_id":{"type":"object"},"user":{"type":"object"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}},"paths":{"/api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities":{"get":{"summary":"List Virtual Environment Version Flow Priorities","description":"Retrieves a paginated list of flow priorities for a specific virtual environment version.","parameters":[{"name":"virtual_environment_version","in":"path","required":true,"schema":{"type":"string"},"description":"The virtual environment version identifier."},{"name":"include","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of relationships to include. Available: virtualEnvironmentVersion, flow"},{"name":"sort","in":"query","required":false,"schema":{"type":"string"},"description":"Sort field. Prefix with - for descending. Available: id, created_at"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1},"description":"Page number for pagination."},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Number of results per page."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualEnvironmentVersionsListResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Virtual Environment Versions"]}}}} ``` ## Create Virtual Environment Version Flow Priority > Creates a new flow priority for a specific virtual environment version. ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Virtual Environment Versions"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"VirtualEnvironmentVersionsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/VirtualEnvironmentVersions"}}},"VirtualEnvironmentVersions":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"flow_id":{"type":"string"},"priority":{"type":"integer"},"model_type":{"type":"string"},"original_model_id":{"type":"string"},"replacement_model_id":{"type":"string"},"type":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"fallback":{"type":"string"},"date_format":{"type":"string"},"secret":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"version":{"type":"object"},"virtual_environment_id":{"type":"object"},"virtual_environment":{"type":"object"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"deployed_at":{"type":"array","items":{"type":"object"},"format":"date-time"},"deployed_by":{"type":"array","items":{"type":"object"}},"notes":{"type":"array","items":{"type":"object"}},"manifests":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"counts":{"type":"string"},"user_id":{"type":"object"},"user":{"type":"object"}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"VirtualEnvironmentVersionsStoreFlowPrioritiesRequest":{"type":"object","properties":{"flow_id":{"type":"string"},"priority":{"type":"integer"},"notes":{"type":"string"}},"required":["flow_id","priority"]}}},"paths":{"/api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities":{"post":{"summary":"Create Virtual Environment Version Flow Priority","description":"Creates a new flow priority for a specific virtual environment version.","parameters":[{"name":"virtual_environment_version","in":"path","required":true,"schema":{"type":"string"},"description":"The virtual environment version identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualEnvironmentVersionsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualEnvironmentVersionsStoreFlowPrioritiesRequest"}}}},"tags":["Virtual Environment Versions"]}}}} ``` ## Update Virtual Environment Version Flow Priority > Updates an existing flow priority for a specific virtual environment version. ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Virtual Environment Versions"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"VirtualEnvironmentVersionsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/VirtualEnvironmentVersions"}}},"VirtualEnvironmentVersions":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"flow_id":{"type":"string"},"priority":{"type":"integer"},"model_type":{"type":"string"},"original_model_id":{"type":"string"},"replacement_model_id":{"type":"string"},"type":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"fallback":{"type":"string"},"date_format":{"type":"string"},"secret":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"version":{"type":"object"},"virtual_environment_id":{"type":"object"},"virtual_environment":{"type":"object"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"deployed_at":{"type":"array","items":{"type":"object"},"format":"date-time"},"deployed_by":{"type":"array","items":{"type":"object"}},"notes":{"type":"array","items":{"type":"object"}},"manifests":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"counts":{"type":"string"},"user_id":{"type":"object"},"user":{"type":"object"}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"VirtualEnvironmentVersionsUpdateFlowPrioritiesRequest":{"type":"object","properties":{"flow_id":{"type":"string"},"priority":{"type":"integer"},"notes":{"type":"string"}}}}},"paths":{"/api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities/{flow_priority}":{"put":{"summary":"Update Virtual Environment Version Flow Priority","description":"Updates an existing flow priority for a specific virtual environment version.","parameters":[{"name":"virtual_environment_version","in":"path","required":true,"schema":{"type":"string"},"description":"The virtual environment version identifier."},{"name":"flow_priority","in":"path","required":true,"schema":{"type":"string"},"description":"The flow priority identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualEnvironmentVersionsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualEnvironmentVersionsUpdateFlowPrioritiesRequest"}}}},"tags":["Virtual Environment Versions"]}}}} ``` ## Delete Virtual Environment Version Flow Priority > Permanently deletes a specific flow priority for a specific virtual environment version. ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Virtual Environment Versions"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"MessageResponse":{"type":"object","properties":{"message":{"type":"string"}}}}},"paths":{"/api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities/{flow_priority}":{"delete":{"summary":"Delete Virtual Environment Version Flow Priority","description":"Permanently deletes a specific flow priority for a specific virtual environment version.","parameters":[{"name":"virtual_environment_version","in":"path","required":true,"schema":{"type":"string"},"description":"The virtual environment version identifier."},{"name":"flow_priority","in":"path","required":true,"schema":{"type":"string"},"description":"The flow priority identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Virtual Environment Versions"]}}}} ``` ## List Virtual Environment Version Manifests > Retrieves a paginated list of component replacement rules for a specific virtual environment version. ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Virtual Environment Versions"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"VirtualEnvironmentVersionsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VirtualEnvironmentVersions"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"VirtualEnvironmentVersions":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"flow_id":{"type":"string"},"priority":{"type":"integer"},"model_type":{"type":"string"},"original_model_id":{"type":"string"},"replacement_model_id":{"type":"string"},"type":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"fallback":{"type":"string"},"date_format":{"type":"string"},"secret":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"version":{"type":"object"},"virtual_environment_id":{"type":"object"},"virtual_environment":{"type":"object"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"deployed_at":{"type":"array","items":{"type":"object"},"format":"date-time"},"deployed_by":{"type":"array","items":{"type":"object"}},"notes":{"type":"array","items":{"type":"object"}},"manifests":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"counts":{"type":"string"},"user_id":{"type":"object"},"user":{"type":"object"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}},"paths":{"/api/v1/virtual-environment-versions/{virtual_environment_version}/manifests":{"get":{"summary":"List Virtual Environment Version Manifests","description":"Retrieves a paginated list of component replacement rules for a specific virtual environment version.","parameters":[{"name":"virtual_environment_version","in":"path","required":true,"schema":{"type":"string"},"description":"The virtual environment version identifier."},{"name":"filter[model_type]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by model_type."},{"name":"include","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of relationships to include. Available: virtualEnvironmentVersion, originalModel, replacementModel"},{"name":"sort","in":"query","required":false,"schema":{"type":"string"},"description":"Sort field. Prefix with - for descending. Available: id, created_at"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1},"description":"Page number for pagination."},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Number of results per page."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualEnvironmentVersionsListResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Virtual Environment Versions"]}}}} ``` ## Create Virtual Environment Version Manifest > Creates a new component replacement rule for a specific virtual environment version. ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Virtual Environment Versions"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"VirtualEnvironmentVersionsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/VirtualEnvironmentVersions"}}},"VirtualEnvironmentVersions":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"flow_id":{"type":"string"},"priority":{"type":"integer"},"model_type":{"type":"string"},"original_model_id":{"type":"string"},"replacement_model_id":{"type":"string"},"type":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"fallback":{"type":"string"},"date_format":{"type":"string"},"secret":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"version":{"type":"object"},"virtual_environment_id":{"type":"object"},"virtual_environment":{"type":"object"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"deployed_at":{"type":"array","items":{"type":"object"},"format":"date-time"},"deployed_by":{"type":"array","items":{"type":"object"}},"notes":{"type":"array","items":{"type":"object"}},"manifests":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"counts":{"type":"string"},"user_id":{"type":"object"},"user":{"type":"object"}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"VirtualEnvironmentVersionsStoreManifestsRequest":{"type":"object","properties":{"model_type":{"type":"string"},"original_model_id":{"type":"string"},"replacement_model_id":{"type":"string"}},"required":["model_type","original_model_id","replacement_model_id"]}}},"paths":{"/api/v1/virtual-environment-versions/{virtual_environment_version}/manifests":{"post":{"summary":"Create Virtual Environment Version Manifest","description":"Creates a new component replacement rule for a specific virtual environment version.","parameters":[{"name":"virtual_environment_version","in":"path","required":true,"schema":{"type":"string"},"description":"The virtual environment version identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualEnvironmentVersionsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualEnvironmentVersionsStoreManifestsRequest"}}}},"tags":["Virtual Environment Versions"]}}}} ``` ## Get Virtual Environment Version Manifest > Retrieves the details of a specific component replacement rule for a specific virtual environment version. ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Virtual Environment Versions"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"VirtualEnvironmentVersionsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/VirtualEnvironmentVersions"}}},"VirtualEnvironmentVersions":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"flow_id":{"type":"string"},"priority":{"type":"integer"},"model_type":{"type":"string"},"original_model_id":{"type":"string"},"replacement_model_id":{"type":"string"},"type":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"fallback":{"type":"string"},"date_format":{"type":"string"},"secret":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"version":{"type":"object"},"virtual_environment_id":{"type":"object"},"virtual_environment":{"type":"object"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"deployed_at":{"type":"array","items":{"type":"object"},"format":"date-time"},"deployed_by":{"type":"array","items":{"type":"object"}},"notes":{"type":"array","items":{"type":"object"}},"manifests":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"counts":{"type":"string"},"user_id":{"type":"object"},"user":{"type":"object"}}}}},"paths":{"/api/v1/virtual-environment-versions/{virtual_environment_version}/manifests/{manifest}":{"get":{"summary":"Get Virtual Environment Version Manifest","description":"Retrieves the details of a specific component replacement rule for a specific virtual environment version.","parameters":[{"name":"virtual_environment_version","in":"path","required":true,"schema":{"type":"string"},"description":"The virtual environment version identifier."},{"name":"manifest","in":"path","required":true,"schema":{"type":"string"},"description":"The manifest identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualEnvironmentVersionsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Virtual Environment Versions"]}}}} ``` ## Update Virtual Environment Version Manifest > Updates an existing component replacement rule for a specific virtual environment version. ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Virtual Environment Versions"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"VirtualEnvironmentVersionsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/VirtualEnvironmentVersions"}}},"VirtualEnvironmentVersions":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"flow_id":{"type":"string"},"priority":{"type":"integer"},"model_type":{"type":"string"},"original_model_id":{"type":"string"},"replacement_model_id":{"type":"string"},"type":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"fallback":{"type":"string"},"date_format":{"type":"string"},"secret":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"version":{"type":"object"},"virtual_environment_id":{"type":"object"},"virtual_environment":{"type":"object"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"deployed_at":{"type":"array","items":{"type":"object"},"format":"date-time"},"deployed_by":{"type":"array","items":{"type":"object"}},"notes":{"type":"array","items":{"type":"object"}},"manifests":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"counts":{"type":"string"},"user_id":{"type":"object"},"user":{"type":"object"}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"VirtualEnvironmentVersionsUpdateManifestsRequest":{"type":"object","properties":{"model_type":{"type":"string"},"original_model_id":{"type":"string"},"replacement_model_id":{"type":"string"}}}}},"paths":{"/api/v1/virtual-environment-versions/{virtual_environment_version}/manifests/{manifest}":{"put":{"summary":"Update Virtual Environment Version Manifest","description":"Updates an existing component replacement rule for a specific virtual environment version.","parameters":[{"name":"virtual_environment_version","in":"path","required":true,"schema":{"type":"string"},"description":"The virtual environment version identifier."},{"name":"manifest","in":"path","required":true,"schema":{"type":"string"},"description":"The manifest identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualEnvironmentVersionsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualEnvironmentVersionsUpdateManifestsRequest"}}}},"tags":["Virtual Environment Versions"]}}}} ``` ## Delete Virtual Environment Version Manifest > Permanently deletes a specific component replacement rule for a specific virtual environment version. ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Virtual Environment Versions"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"MessageResponse":{"type":"object","properties":{"message":{"type":"string"}}}}},"paths":{"/api/v1/virtual-environment-versions/{virtual_environment_version}/manifests/{manifest}":{"delete":{"summary":"Delete Virtual Environment Version Manifest","description":"Permanently deletes a specific component replacement rule for a specific virtual environment version.","parameters":[{"name":"virtual_environment_version","in":"path","required":true,"schema":{"type":"string"},"description":"The virtual environment version identifier."},{"name":"manifest","in":"path","required":true,"schema":{"type":"string"},"description":"The manifest identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Virtual Environment Versions"]}}}} ``` ## List Virtual Environment Version Variables > Retrieves a paginated list of variables for a specific virtual environment version. ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Virtual Environment Versions"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"VariablesListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Variables"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Variables":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"label":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"secret":{"type":"string"},"locked":{"type":"string"},"configurable":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"modified":{"type":"string"},"pivot":{"type":"string"},"required":{"type":"boolean"},"advanced":{"type":"boolean"},"alias":{"type":"string"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}},"paths":{"/api/v1/virtual-environment-versions/{virtual_environment_version}/variables":{"get":{"summary":"List Virtual Environment Version Variables","description":"Retrieves a paginated list of variables for a specific virtual environment version.","parameters":[{"name":"virtual_environment_version","in":"path","required":true,"schema":{"type":"string"},"description":"The virtual environment version identifier."},{"name":"filter[label]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by label."},{"name":"filter[key]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by key."},{"name":"filter[value]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by value."},{"name":"sort","in":"query","required":false,"schema":{"type":"string"},"description":"Sort field. Prefix with - for descending. Available: label, key, value"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1},"description":"Page number for pagination."},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Number of results per page."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariablesListResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Virtual Environment Versions"]}}}} ``` ## Create Virtual Environment Version Variable > Creates a new variable for a specific virtual environment version. ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Virtual Environment Versions"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"VariablesResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Variables"}}},"Variables":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"label":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"secret":{"type":"string"},"locked":{"type":"string"},"configurable":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"modified":{"type":"string"},"pivot":{"type":"string"},"required":{"type":"boolean"},"advanced":{"type":"boolean"},"alias":{"type":"string"}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"VirtualEnvironmentVersionsStoreVariablesRequest":{"type":"object","properties":{"type":{"type":"string"},"key":{"type":"string","minLength":1},"value":{"type":"string","maximum":1024},"fallback":{"type":"string","maxLength":1024,"nullable":true},"date_format":{"type":"string","nullable":true},"secret":{"type":"string"}},"required":["key","type"]}}},"paths":{"/api/v1/virtual-environment-versions/{virtual_environment_version}/variables":{"post":{"summary":"Create Virtual Environment Version Variable","description":"Creates a new variable for a specific virtual environment version.","parameters":[{"name":"virtual_environment_version","in":"path","required":true,"schema":{"type":"string"},"description":"The virtual environment version identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariablesResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualEnvironmentVersionsStoreVariablesRequest"}}}},"tags":["Virtual Environment Versions"]}}}} ``` ## Update Virtual Environment Version Variable > Updates an existing variable for a specific virtual environment version. ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Virtual Environment Versions"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"VariablesResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Variables"}}},"Variables":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"label":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"secret":{"type":"string"},"locked":{"type":"string"},"configurable":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"modified":{"type":"string"},"pivot":{"type":"string"},"required":{"type":"boolean"},"advanced":{"type":"boolean"},"alias":{"type":"string"}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"VirtualEnvironmentVersionsUpdateVariablesRequest":{"type":"object","properties":{"type":{"type":"string"},"key":{"type":"string","minLength":1},"value":{"type":"string","maximum":1024},"fallback":{"type":"string","maxLength":1024,"nullable":true},"date_format":{"type":"string","nullable":true},"secret":{"type":"string"}}}}},"paths":{"/api/v1/virtual-environment-versions/{virtual_environment_version}/variables/{variable}":{"put":{"summary":"Update Virtual Environment Version Variable","description":"Updates an existing variable for a specific virtual environment version.","parameters":[{"name":"virtual_environment_version","in":"path","required":true,"schema":{"type":"string"},"description":"The virtual environment version identifier."},{"name":"variable","in":"path","required":true,"schema":{"type":"string"},"description":"The variable identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariablesResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualEnvironmentVersionsUpdateVariablesRequest"}}}},"tags":["Virtual Environment Versions"]}}}} ``` ## Delete Virtual Environment Version Variable > Permanently deletes a specific variable for a specific virtual environment version. ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Virtual Environment Versions"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"MessageResponse":{"type":"object","properties":{"message":{"type":"string"}}}}},"paths":{"/api/v1/virtual-environment-versions/{virtual_environment_version}/variables/{variable}":{"delete":{"summary":"Delete Virtual Environment Version Variable","description":"Permanently deletes a specific variable for a specific virtual environment version.","parameters":[{"name":"virtual_environment_version","in":"path","required":true,"schema":{"type":"string"},"description":"The virtual environment version identifier."},{"name":"variable","in":"path","required":true,"schema":{"type":"string"},"description":"The variable identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Virtual Environment Versions"]}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://doc.wearepatchworks.com/product-documentation/api-reference/virtual-environments-and-packages/virtual-environment-versions.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.