v1

latestOpenAPI 3.0.3Apache 2.02026-07-17302459.9 KB

Data Jobs Deployment

Creates or updates a deployment of a Data Job. | (Stable)

(Introduced in v1.0) | Creates or updates a deployment of a Data Job. The API returns before the actual Job is deployed (the operation is asynchrounous). Depending on settings specified during Data Job creation, clients will get an e-mail in case of success or failure of the deployment. If you need to change only deployment settings without changing the job version, use PATCH deployments request which is synchronous.

post/data-jobs/for-team/{team_name}/jobs/{job_name}/deployments

Query parameters

send_notificationboolean

Allows administrators to disable sending notification during maintance window for platfrom errors - e.g if all jobs are being re-deployed due to migration or after recovering from an outage. Monitoring data will still be popoulated so deployment status can be monitored by admins.

Request body

vdk_versionstring

A specific VDK version to use

job_versionstring

Job version (can be Git commit)

python_versionstring

A python release version (supported by the service) to be used for job deployments.

mode'testing' | 'release'

The execution mode that the data job is deployed in. Data Jobs used for development or testing purposes are marked as testing. This is used by Operations team on platform rollout and infrastructure changes adoption. For example, rollout and validation of testing jobs first, then proceeding with release data jobs. Also, testing and release jobs may have different limits and SLA targets.

idstring

String that identifies a single deployment of a Data Job. Currently only one single deployment per Data Job is possible. In the future: It's recommended to use following ids - development, testing, production. However users are free to come up with their own. For example, this enables the creation of 3 different deployments, using the same Data Job code: development deployment --deployment-id development testing deployment --deployment-id testing production deployment --deployment-id prod

enabledboolean

Enable/disable flag

deployed_bystring

User or service that deployed the Data Job

deployed_datestring date-time

The Data Job deployment date

Example request

{
  "job_version": "11a403ba",
  "python_version": "3.9",
  "mode": "release",
  "id": "release",
  "deployed_by": "auserov@example.mail.com",
  "schedule": {
    "schedule_cron": "0 0 13 * 5"
  },
  "resources": {
    "cpu_request": 10,
    "cpu_limit": 20,
    "memory_request": 1024,
    "memory_limit": 2048
  }
}

Response

Update accepted successfully.