Skip to main content

FINBOURNE Scheduler API

Project description

Documentation for API Endpoints

All URIs are relative to https://fbn-prd.lusid.com/scheduler2

Class Method HTTP request Description
ApplicationMetadataApi list_access_controlled_resources GET /api/metadata/access/resources [EXPERIMENTAL] ListAccessControlledResources: Get resources available for access control
ImagesApi delete_image DELETE /api/images/{name} [EXPERIMENTAL] DeleteImage: Delete a Docker Image
ImagesApi download_image GET /api/images/{name}/contents [EXPERIMENTAL] DownloadImage: Download Docker Image
ImagesApi get_image GET /api/images/{name} [EXPERIMENTAL] GetImage: Get metadata of a Docker Image
ImagesApi list_images GET /api/images/repository/{name} [EXPERIMENTAL] ListImages: List all images under same image repository
ImagesApi list_repositories GET /api/images/repository [EXPERIMENTAL] ListRepositories: List all Docker image repositories
ImagesApi upload_image POST /api/images [EXPERIMENTAL] UploadImage: Upload a Docker Image used for Scheduler jobs
JobsApi create_job POST /api/jobs [EXPERIMENTAL] CreateJob: Create a new job
JobsApi delete_job DELETE /api/jobs/{scope}/{code} [EXPERIMENTAL] DeleteJob: Delete a job
JobsApi get_history GET /api/jobs/history [EXPERIMENTAL] GetHistory: Get the history of job runs
JobsApi get_job_console_output GET /api/jobs/history/{runId}/console [EXPERIMENTAL] GetJobConsoleOutput: Gets the console output of a specific job run
JobsApi get_run_history GET /api/jobs/history/{runId} [EXPERIMENTAL] GetRunHistory: Get the history for a single job run
JobsApi get_schedules_for_a_job GET /api/jobs/{scope}/{code}/schedules [EXPERIMENTAL] GetSchedulesForAJob: Get all the schedules for a single job
JobsApi list_jobs GET /api/jobs [EXPERIMENTAL] ListJobs: List the available jobs
JobsApi run_job POST /api/jobs/{scope}/{code}/$run RunJob: Run a job immediately
JobsApi update_job PUT /api/jobs/{scope}/{code} [EXPERIMENTAL] UpdateJob: Update a JobDefinition
SchedulesApi create_schedule POST /api/schedules [EXPERIMENTAL] CreateSchedule: Create a Schedule for a job
SchedulesApi delete_schedule DELETE /api/schedules/{scope}/{code} [EXPERIMENTAL] DeleteSchedule: Delete a schedule
SchedulesApi enabled_schedule PUT /api/schedules/{scope}/{code}/enabled [EXPERIMENTAL] EnabledSchedule: Enable/disable a schedule
SchedulesApi get_schedule GET /api/schedules/{scope}/{code} [EXPERIMENTAL] GetSchedule: Get a single Schedule
SchedulesApi list_schedules GET /api/schedules [EXPERIMENTAL] ListSchedules: List the available Schedules
SchedulesApi run_schedule POST /api/schedules/{scope}/{code}/$run [EXPERIMENTAL] RunSchedule: Run a schedule immediately
SchedulesApi update_schedule PUT /api/schedules/{scope}/{code} [EXPERIMENTAL] UpdateSchedule: Update a schedule.

Documentation for Models

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lusid_scheduler_sdk-2.1.49.tar.gz (68.8 kB view hashes)

Uploaded Source

Built Distribution

lusid_scheduler_sdk-2.1.49-py3-none-any.whl (125.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page