latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

Deployment

Create Deployment

Used to create new deployments

post/deployments

Request body

idstring

The ID of the deployment

created_timeinteger

Time at which the deployment was created

created_by_idstring

The ID of the user who created this deployment

last_updated_timeinteger

Time at which the deployment was last updated

last_updated_by_idstring

The ID of the user who last updated this deployment

organization_idstring

The ID of the organization associated with this deployment

application_idstring

The ID of the application associated with this deployment

environment_idstring

The ID of the environment associated with this deployment

namestring

The display name of the deployment

uristring

URI of the deployment (empty for mobile_application deployment type)

deployment_type'web_application' | 'api' | 'mobile_application'

The type of the deployment.

variablesobject

Variables for this deployment. Overrides variables with the same name specified in the environment configuration.

link_agent_labelstring

DEPRECATED - use link_agent_labels

link_agent_labelsstring[]

Overrides the link_agent_labels in the associated environment

link_bypass_mabl_proxyboolean

Overrides the link_bypass_mabl_proxy in the associated environment (mabl link only)

use_personal_link_agentboolean

Route this run's test traffic through the triggering user's own personal mablnet Link tunnels (tunnels whose egress is that user's machine), in addition to the environment's configured link agents. The owner is the user who triggers the run, resolved server-side — there is no id to pass. By default the run stripes across every live personal tunnel the user has (e.g. one per machine); set personal_link_tunnel_label to pin it to one. mablnet-only; requires that user to have at least one live personal Link Agent connected.

personal_link_tunnel_labelstring

Restrict use_personal_link_agent to a single personal tunnel by its Link label (the tunnel-safe machine hostname the user's link-agents start --personal registers under), instead of striping across all of the user's live personal tunnels. Ignored when use_personal_link_agent is not set.

source_control_tag_targetstring

Overrides the source_control_tag_target in the associated environment

mobile_app_file_idstring

Identifier of mobile app file for this deployment (empty for web_application and api deployment types)

Response

The deployment that was created

idstring

The ID of the deployment

created_timeinteger

Time at which the deployment was created

created_by_idstring

The ID of the user who created this deployment

last_updated_timeinteger

Time at which the deployment was last updated

last_updated_by_idstring

The ID of the user who last updated this deployment

organization_idstring

The ID of the organization associated with this deployment

application_idstring

The ID of the application associated with this deployment

environment_idstring

The ID of the environment associated with this deployment

namestring

The display name of the deployment

uristring

URI of the deployment (empty for mobile_application deployment type)

deployment_type'web_application' | 'api' | 'mobile_application'

The type of the deployment.

variablesobject

Variables for this deployment. Overrides variables with the same name specified in the environment configuration.

link_agent_labelstring

DEPRECATED - use link_agent_labels

link_agent_labelsstring[]

Overrides the link_agent_labels in the associated environment

link_bypass_mabl_proxyboolean

Overrides the link_bypass_mabl_proxy in the associated environment (mabl link only)

use_personal_link_agentboolean

Route this run's test traffic through the triggering user's own personal mablnet Link tunnels (tunnels whose egress is that user's machine), in addition to the environment's configured link agents. The owner is the user who triggers the run, resolved server-side — there is no id to pass. By default the run stripes across every live personal tunnel the user has (e.g. one per machine); set personal_link_tunnel_label to pin it to one. mablnet-only; requires that user to have at least one live personal Link Agent connected.

personal_link_tunnel_labelstring

Restrict use_personal_link_agent to a single personal tunnel by its Link label (the tunnel-safe machine hostname the user's link-agents start --personal registers under), instead of striping across all of the user's live personal tunnels. Ignored when use_personal_link_agent is not set.

source_control_tag_targetstring

Overrides the source_control_tag_target in the associated environment

mobile_app_file_idstring

Identifier of mobile app file for this deployment (empty for web_application and api deployment types)