Flow Version Deployments

Index

get

List all flow version deployments.

Authorizations
Query parameters
filter[package_id]stringOptional

Filter results by package_id.

filter[virtual_environment_id]stringOptional

Filter results by virtual_environment_id.

filter[global]stringOptional

Filter results by global.

filter[flowVersion.flow]stringOptional

Filter results by flowVersion.flow.

filter[name]stringOptional

Filter results by name.

filter[LIKE]stringOptional

Filter results by LIKE.

includestringOptional

Comma-separated list of relationships to include. Available: enabledBy, flowVersion, virtualEnvironment, package, user

sortstringOptional

Sort field. Prefix with - for descending. Available: created_at, enabled_at, flow_name, DESC, ASC, flow_versions, flow_version_deployments.flow_version_id, =, flow_versions.id, flows, flow_versions.flow_id, =, flows.id, flows.name, flow_version_iteration, DESC, ASC, flow_versions.id, ( SELECT COUNT(*) FROM flow_versions fv2 WHERE fv2.flow_id = flow_versions.flow_id AND fv2.id <= flow_versions.id ) AS iteration, flow_versions, flow_versions.id, flow_versions, flow_version_deployments.flow_version_id, =, flow_versions.id, iteration_calc, flow_versions.id, =, iteration_calc.id, iteration_calc.iteration

pageinteger · min: 1Optional

Page number for pagination.

Default: 1
per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses
get
/api/v1/flow-version-deployments

No content

Get Packages

get

Get Packages for packages.

Authorizations
Query parameters
filter[name]stringOptional

Filter results by name.

includestringOptional

Comma-separated list of relationships to include. Available: createdBy, flowVersions.deployments, virtualEnvironments, deployments.virtualEnvironment.deployedVersion, deployments.user, package, flowVersionDeployments, flowVersionDeployments, flowVersionDeployments

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
get
/api/v1/flow-version-deployments/packages

No content

Get Virtual Environments

get

Get Virtual Environments for virtual environments.

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
get
/api/v1/flow-version-deployments/virtual-environments

No content

Last updated

Was this helpful?