GET

Job Instance

API endpoint that allows jobs to be viewed or edited.

Pass the start_now url parameter to the POST method to enqueue the job immediately.

Use the delay field to create a test job with fake duration of work (in seconds).

Actions

/jobs/{id}/run/ (POST)

Run a job (add it to the queue).

/jobs/{id}/cancel/ (POST)

Cancel a job (terminate the background task)

GET /api/v2/jobs/853/?format=api
HTTP 200 OK
Allow: GET, PUT, PATCH, DELETE, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 853,
    "details": "https://api.beluga.insectai.org/api/v2/jobs/853/?format=api",
    "name": "Sync captures for deployment 123",
    "delay": 0,
    "limit": 1000,
    "shuffle": true,
    "project": {
        "id": 45,
        "name": "AMBER - Costa Rica",
        "details": "https://api.beluga.insectai.org/api/v2/projects/45/?format=api",
        "user_permissions": []
    },
    "deployment": {
        "id": 123,
        "name": "Costa Rica - Restoration",
        "details": "https://api.beluga.insectai.org/api/v2/deployments/123/?format=api",
        "user_permissions": []
    },
    "source_image_collection": null,
    "source_image_single": null,
    "pipeline": null,
    "status": "SUCCESS",
    "created_at": "2024-09-12T19:41:15.604907",
    "updated_at": "2024-11-13T17:15:33.750572",
    "started_at": "2024-09-12T19:41:15.678650",
    "finished_at": "2024-09-12T19:41:21.425302",
    "duration": "5.746652",
    "progress": {
        "summary": {
            "status": "SUCCESS",
            "progress": 1.0
        },
        "stages": [
            {
                "status": "SUCCESS",
                "progress": 1.0,
                "key": "data_storage_sync",
                "name": "Data storage sync",
                "params": [
                    {
                        "name": "Total Files",
                        "key": "total_files",
                        "category": "default",
                        "value": 3419
                    }
                ]
            },
            {
                "status": "SUCCESS",
                "progress": 1.0,
                "key": "update_deployment_cache",
                "name": "Update deployment cache",
                "params": []
            }
        ],
        "errors": [],
        "logs": [
            "[2024-09-12 19:41:21] INFO Finished job #853 \"Sync captures for deployment 123\" (SUCCESS) NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|",
            "[2024-09-12 19:41:21] INFO Changing status of job 853 to SUCCESS NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|",
            "[2024-09-12 19:41:21] INFO Finished syncing captures for deployment #123 Costa Rica - Restoration NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|",
            "[2024-09-12 19:41:20] INFO Saving and recalculating sessions for deployment NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|",
            "[2024-09-12 19:41:20] INFO Processed 3419 files NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|",
            "[2024-09-12 19:41:19] INFO Processed 3000 files NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|",
            "[2024-09-12 19:41:18] INFO Processed 2000 files NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|",
            "[2024-09-12 19:41:17] INFO Processed 1000 files NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|",
            "[2024-09-12 19:41:15] INFO Syncing captures for deployment #123 Costa Rica - Restoration NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|",
            "[2024-09-12 19:41:15] INFO Changing status of job 853 to STARTED NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|",
            "[2024-09-12 19:41:15] INFO Running job #853 \"Sync captures for deployment 123\" (PENDING) NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|"
        ]
    },
    "logs": {
        "stdout": [
            "[2024-09-12 19:41:21] INFO Finished job #853 \"Sync captures for deployment 123\" (SUCCESS) NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|",
            "[2024-09-12 19:41:21] INFO Changing status of job 853 to SUCCESS NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|",
            "[2024-09-12 19:41:21] INFO Finished syncing captures for deployment #123 Costa Rica - Restoration NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|",
            "[2024-09-12 19:41:20] INFO Saving and recalculating sessions for deployment NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|",
            "[2024-09-12 19:41:20] INFO Processed 3419 files NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|",
            "[2024-09-12 19:41:19] INFO Processed 3000 files NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|",
            "[2024-09-12 19:41:18] INFO Processed 2000 files NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|",
            "[2024-09-12 19:41:17] INFO Processed 1000 files NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|",
            "[2024-09-12 19:41:15] INFO Syncing captures for deployment #123 Costa Rica - Restoration NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|",
            "[2024-09-12 19:41:15] INFO Changing status of job 853 to STARTED NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|",
            "[2024-09-12 19:41:15] INFO Running job #853 \"Sync captures for deployment 123\" (PENDING) NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|fdc4c87e65e4|47343f58098eb2c56202c20a36f74cd3|053dbbe7cc59ee2b|AMI%20Backend%20%28Staging%29|"
        ],
        "stderr": []
    },
    "job_type": {
        "name": "Data storage sync",
        "key": "data_storage_sync"
    },
    "data_export": null,
    "dispatch_mode": "internal",
    "result": null,
    "user_permissions": []
}