DeployContext

DeployContext represents the configuration and settings for a deployment operation on a stack. It contains all the parameters and options that control how a deployment is executed, including infrastructure updates, security patches, deployment strategies, and operational settings.

Model

idinteger

Unique identifier for the deploy context.

stack_idinteger

The ID of the stack this deploy context belongs to.

uidstring

Unique identifier string for the deploy context, automatically generated with format dc-{hex}.

typestring

The type of deploy context, indicating the specific deployment strategy or framework being used.

created_atstring

ISO8601 timestamp when the deploy context was created.

updated_atstring

ISO8601 timestamp when the deploy context was last updated.

apply_infrastructure_upgradesboolean

Whether to apply infrastructure upgrades during deployment. When true, servers may be updated with latest operating system packages and infrastructure components.

apply_security_upgradesboolean

Whether to apply security patches and updates during deployment. Focuses specifically on security-related package updates.

async_action_idinteger

ID of the associated async action that tracks the deployment operation's progress and status.

authorized_bystring

Identifier of the user or system that authorized this deployment context.

auto_update_docker_versionsboolean

Whether to automatically update Docker versions during infrastructure upgrades. Only applies when apply_infrastructure_upgrades is true.

deploy_strategystring

The deployment strategy to use (e.g., rolling, parallel, serial). Defines how the deployment is executed across multiple servers.

deploy_typestring

The type of deployment operation (e.g., redeploy, build, scale, revert). Determines the specific deployment workflow to execute.

deployment_profile_idinteger

ID of the deployment profile containing predefined deployment settings and configurations.

force_infrastructure_upgradesboolean

Whether to force infrastructure upgrades even if they might cause downtime. Only applies when apply_infrastructure_upgrades is true.

github_deployment_idinteger

ID of the associated GitHub deployment when triggered via GitHub integration.

reboot_serversboolean

Whether servers should be rebooted after deployment if required by infrastructure or security updates.

triggered_bystring

Identifier of the user or system that triggered this deployment.

triggered_viastring

The method or interface used to trigger the deployment (e.g., web, api, webhook, git).

is_advancedboolean

Whether this deployment uses advanced configuration options or custom settings.

scaler_idinteger

ID of the scaler configuration used for auto-scaling deployments.

take_server_snapshotsboolean

Whether to create server snapshots before performing the deployment for rollback purposes.

Related Models:Stack Async Action

Example

{
  "id": 78901,
  "stack_id": 12345,
  "uid": "dc-a1b2c3d4e5f6",
  "type": "kubernetes",
  "created_at": "2024-02-15T09:30:00Z",
  "updated_at": "2024-02-15T10:15:00Z",
  "apply_infrastructure_upgrades": true,
  "apply_security_upgrades": true,
  "async_action_id": 55667,
  "authorized_by": "user-456",
  "auto_update_docker_versions": true,
  "deploy_strategy": "rolling",
  "deploy_type": "redeploy",
  "deployment_profile_id": 123,
  "force_infrastructure_upgrades": false,
  "github_deployment_id": 789012,
  "reboot_servers": false,
  "triggered_by": "john@example.com",
  "triggered_via": "webhook",
  "is_advanced": false,
  "scaler_id": 334,
  "take_server_snapshots": true
}

Edit this page