Sign in
Virtual Environments

Get Virtual Environments

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

get/api/v1/flow-version-deployments/virtual-environments

Query parameters

filter[name]string

Filter results by name.

filter[type]string

Filter results by type.

filter[status]string

Filter results by status.

filter[hasDeployedVersion]string

Filter results by hasDeployedVersion.

filter[labelled]string

Filter results by label id.

includestring

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

sortstring

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

pageinteger

Page number for pagination.

per_pageinteger

Number of results per page.

Response

Successful response

object required

Changes

No recorded changes to this endpoint across all 1 revision of this API.