v1
ApplicationAPI & CLI
Double column
API
CLI
JS client

Jobs /

Update job deployment

Updates the deployment settings of the given job.

Path parameters

    • projectId

      string required

      ID of the project

    • jobId

      string required

      ID of the job

Request body

  • {object}

    An external deployment

    • external

      {object}

      • imagePath

        string required

        Path of the external image excluding the hostname

      • credentials

        string

        ID of the saved credentials to use to access this external image.

        pattern
        ^[A-Za-z0-9-]+$

OR

  • {object}

    An internal deployment

    • internal

      {object}

      • id

        string

        ID of the build service to deploy

        pattern
        ^[A-Za-z0-9-]+$

      • branch

        string

        Branch to deploy

      • buildSHA

        Commit SHA to deploy, or 'latest' to deploy the most recent commit

API
CLI
JS client

POST /v1/projects/{projectId}/jobs/{jobId}/deployment

Example request

request body

internal

curl
curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"internal":{"id":"build-service","buildSHA":"latest","branch":"master"}}' \
  https://api.northflank.com/v1/projects/{projectId}/jobs/{jobId}/deployment

OR

external

curl
curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"external":{"imagePath":"nginx:latest","credentials":"example-credentials"}}' \
  https://api.northflank.com/v1/projects/{projectId}/jobs/{jobId}/deployment

Example response

200 OK

success

© 2021 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com