NOnotefile
jobs

POST /v1/projects/{projectOrProductUID}/jobs

Changed on

Create a new batch job with an optional name

Request

  • Base URL
    https://api.notefile.net
  • URL
    https://api.notefile.net/v1/projects/{projectOrProductUID}/jobs
  • Auth
    HTTP bearer

Path parameters

projectOrProductUIDstring required

Query parameters

namestring required

Name for the job

Request body

commentstring

Human-readable description of the job

device_requestsobject

Device-specific request overrides, keyed by device UID

Example request

{
  "comment": "Set environment variables on all devices in a fleet",
  "default_requests": {
    "vars_to_set": {
      "firmware_channel": "production",
      "log_level": "1"
    }
  },
  "select": {
    "devices_in_fleets": [
      "fleet:00000000-0000-0000-0000-000000000000"
    ]
  }
}

Response

Job created successfully

job_uidstring required

The unique identifier for the created job

Changes

  • bb5b45c61752Revision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property //

  • 1887e880199aRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status