---
title: "Run job"
method: POST
path: "/v1/projects/{projectId}/jobs/{jobId}/runs"
tags: ["Jobs", "project"]
---

# Run job

`POST /v1/projects/{projectId}/jobs/{jobId}/runs`

## Request

- Base URL: `https://placeholder/v1`
- URL: `https://placeholder/v1/v1/projects/{projectId}/jobs/{jobId}/runs`
- Auth: none required
- TypeScript: <https://skmtc.dev/northflank/apis/northflank-api/docs/v1/projects/:projectId/jobs/:jobId/runs/post.ts> (a function with typed inputs; its response is checked against the schema)

Starts a new job run for the given job

## Path parameters

- `projectId` string, required: ID of the project
- `jobId` string, required: ID of the job

## Request body

- object
  - `runtimeEnvironment` object: An object containing the environment variables overrides to use when running the job. Keys may only contain letters, numbers, hyphens, forward slashes and dots.
  - `runtimeFiles` object: Secret files as JSON object, encrypted at rest. File path must be absolute
  - `dockerSecretMounts` unknown
  - `billing` object
    - `deploymentPlan` string: The ID of the deployment plan override to use.
  - `deployment` union: Override the job run deployment source.
    - object: Optional: Override the run to use a previously built commit
      - `docker` object: Allows for customization of docker runtime
        - `configType` 'default' | 'customEntrypoint' | 'customCommand' | 'customEntrypointCustomCommand', required: Type of entrypoint & command override configuration
        - `customEntrypoint` string: Custom entrypoint which should be used. Required in case where `configType` is `customEntrypoint` or `customEntrypointCustomCommand`
        - `customCommand` string: Custom command which should be used. Required in case where `configType` is `customCommand` or `customEntrypointCustomCommand`
      - `buildpack` object: Allows for customization of buildpack runtime
        - `configType` 'default' | 'customProcess' | 'customCommand' | 'customEntrypointCustomCommand' | 'originalEntrypointCustomCommand', required: Type of buildpack run configuration
        - `customProcess` string: Custom process which should be run. Required in case where `configType` is `customProcess`
        - `customEntrypoint` string: Custom entrypoint which should be run. Required in case where `configType` is `customEntrypointCustomCommand`
        - `customCommand` string: Custom command which should be run. Required in case where `configType` is `customCommand`, `customEntrypointCustomCommand` or `originalEntrypointCustomCommand`
      - `storage` object
        - `useHdbStorage` boolean
        - `usePdSsdStorage` boolean
        - `ephemeralStorage` object
          - `storageSize` integer: Ephemeral storage per container in MB
        - `shmSize` integer: Configures the amount of available memory-backed disk space available to /dev/shm
      - `gpu` object: GPU configuration overrides to use for this run. Set `enabled` to `false` to run without GPUs.
        - `enabled` boolean: Whether GPUs are enabled for this workload.
        - `configuration` object
          - `gpuType` string, required: The type of GPU to use.
          - `gpuCount` integer: The number of GPUs to allocate.
          - `timesliced` boolean: Whether GPU timeslicing is enabled.
      - `internal` object: Optional: Specify the commit to run
        - `id` union: ID of the build service to deploy
          - string: The ID of a build service in the same project
          - string: The ID of a build service in another project, in the format `project-id/build-service-id`
        - `branch` string: Branch to deploy
        - `buildSHA` union: Commit SHA to deploy, or 'latest' to deploy the most recent commit
          - string: A commit sha.
          - 'latest': Latest commit.
        - `buildId` string: ID of the build that should be deployed
    - object: Optional: Override the run to use an external image
      - `docker` object: Allows for customization of docker runtime
        - `configType` 'default' | 'customEntrypoint' | 'customCommand' | 'customEntrypointCustomCommand', required: Type of entrypoint & command override configuration
        - `customEntrypoint` string: Custom entrypoint which should be used. Required in case where `configType` is `customEntrypoint` or `customEntrypointCustomCommand`
        - `customCommand` string: Custom command which should be used. Required in case where `configType` is `customCommand` or `customEntrypointCustomCommand`
      - `buildpack` object: Allows for customization of buildpack runtime
        - `configType` 'default' | 'customProcess' | 'customCommand' | 'customEntrypointCustomCommand' | 'originalEntrypointCustomCommand', required: Type of buildpack run configuration
        - `customProcess` string: Custom process which should be run. Required in case where `configType` is `customProcess`
        - `customEntrypoint` string: Custom entrypoint which should be run. Required in case where `configType` is `customEntrypointCustomCommand`
        - `customCommand` string: Custom command which should be run. Required in case where `configType` is `customCommand`, `customEntrypointCustomCommand` or `originalEntrypointCustomCommand`
      - `storage` object
        - `useHdbStorage` boolean
        - `usePdSsdStorage` boolean
        - `ephemeralStorage` object
          - `storageSize` integer: Ephemeral storage per container in MB
        - `shmSize` integer: Configures the amount of available memory-backed disk space available to /dev/shm
      - `gpu` object: GPU configuration overrides to use for this run. Set `enabled` to `false` to run without GPUs.
        - `enabled` boolean: Whether GPUs are enabled for this workload.
        - `configuration` object
          - `gpuType` string, required: The type of GPU to use.
          - `gpuCount` integer: The number of GPUs to allocate.
          - `timesliced` boolean: Whether GPU timeslicing is enabled.
      - `external` object: Optional: Specify the external image to run
        - `imagePath` string, required: Image to be deployed. When not deploying from Dockerhub the URL must be specified.
        - `credentials` string: ID of the saved credentials to use to access this external image.
    - object: Optional: Override the run to use an image
      - `docker` object: Allows for customization of docker runtime
        - `configType` 'default' | 'customEntrypoint' | 'customCommand' | 'customEntrypointCustomCommand', required: Type of entrypoint & command override configuration
        - `customEntrypoint` string: Custom entrypoint which should be used. Required in case where `configType` is `customEntrypoint` or `customEntrypointCustomCommand`
        - `customCommand` string: Custom command which should be used. Required in case where `configType` is `customCommand` or `customEntrypointCustomCommand`
      - `buildpack` object: Allows for customization of buildpack runtime
        - `configType` 'default' | 'customProcess' | 'customCommand' | 'customEntrypointCustomCommand' | 'originalEntrypointCustomCommand', required: Type of buildpack run configuration
        - `customProcess` string: Custom process which should be run. Required in case where `configType` is `customProcess`
        - `customEntrypoint` string: Custom entrypoint which should be run. Required in case where `configType` is `customEntrypointCustomCommand`
        - `customCommand` string: Custom command which should be run. Required in case where `configType` is `customCommand`, `customEntrypointCustomCommand` or `originalEntrypointCustomCommand`
      - `storage` object
        - `useHdbStorage` boolean
        - `usePdSsdStorage` boolean
        - `ephemeralStorage` object
          - `storageSize` integer: Ephemeral storage per container in MB
        - `shmSize` integer: Configures the amount of available memory-backed disk space available to /dev/shm
      - `gpu` object: GPU configuration overrides to use for this run. Set `enabled` to `false` to run without GPUs.
        - `enabled` boolean: Whether GPUs are enabled for this workload.
        - `configuration` object
          - `gpuType` string, required: The type of GPU to use.
          - `gpuCount` integer: The number of GPUs to allocate.
          - `timesliced` boolean: Whether GPU timeslicing is enabled.
      - `image` object
        - `projectId` string
        - `name` string, required
        - `group` string
        - `tag` string, required

## Response `200`

Details about the new job run.

---

[API](https://skmtc.dev/northflank/apis/northflank-api.md) - [All operations](https://skmtc.dev/northflank/apis/northflank-api/llms.txt) - [OpenAPI document](https://skmtc.dev/northflank/apis/northflank-api/revisions/6511db980148?raw)