@edgible-team/sdk
    Preparing search index...

    Interface CreateJobRequest

    Body for POST /jobs (handlers/jobs.ts createJob).

    interface CreateJobRequest {
        deviceId: string;
        fulfillImmediately?: boolean;
        input: AnyJobInput;
        jobType: string;
        metadata?: Record<string, unknown>;
        requireActiveConnection?: boolean;
        timeout?: number;
    }
    Index

    Properties

    deviceId fulfillImmediately? input jobType metadata? requireActiveConnection? timeout?

    Properties

    deviceId: string

    Target device; the job is scoped to that device's organization.

    fulfillImmediately?: boolean

    Hold the request open until the job completes (sync mode). Default false.

    input: AnyJobInput
    jobType: string

    Wire job type, e.g. 'restart_workload' — a type value from JOB_TYPES.

    metadata?: Record<string, unknown>
    requireActiveConnection?: boolean

    Fail fast (503) if the device has no live WebSocket connection. Default true.

    timeout?: number

    Job timeout in ms; defaults to the job type's defaultTimeout.

    Settings

    Member Visibility

    On This Page

    Properties