v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Jobs /

Suspend job

Deprecated

This endpoint is deprecated and will be removed in the future. Please avoid making requests to this endpoint.

Requests should instead use the relevant PATCH endpoint.

More details

Modify cron job to toggle suspending of its schedule.

Required permission

Project > Jobs > General > Update

Path parameters

    • projectId

      string required
      ID of the project

    • jobId

      string required
      ID of the job

Request body

  • {object}

    • suspended

      boolean
      In the case of cron jobs, whether scheduling should be paused.

Response body

  • {object}
    Response object.

    • data

      {object} required
      Result data.
    API
    CLI
    JS Client

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

    Example request

    Request body
    curl
    curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"suspended":true}' \
  https://api.northflank.com/v1/projects/{projectId}/jobs/{jobId}/suspend

    Example response

    200 OK

    The operation was performed successfully.

    JSON

    {
  "data": {}
}

    Example response

    409 Conflict

    Setting can only be modified for cron jobs.

    © 2025 Northflank Ltd. All rights reserved.

    northflank.comTermsPrivacyfeedback@northflank.com