IceProd REST API

Datasets

Method	Path	Description
GET	/datasets	get a dict of datasets
POST	/datasets	create new dataset
GET	/datasets/<dataset_id>	get a dataset
PUT	/datasets/<dataset_id>/status	update dataset status
PUT	/datasets/<dataset_id>/description	update dataset description
PUT	/datasets/<dataset_id>/jobs_submitted	update dataset jobs_submitted
GET	/dataset_summaries/status	get dataset ids grouped by status

Config

Method	Path	Description
GET	/config/<dataset_id>	get a config
PUT	/config/<dataset_id>	create/update a config

Jobs

Method	Path	Description
GET	/datasets/<dataset_id>/jobs	get a list of jobs, filtered by dataset_id
GET	/datasets/<dataset_id>/jobs/<job_id>	get a job
PUT	/datasets/<dataset_id>/jobs/<job_id>/status	set a job status
GET	/datasets/<dataset_id>/job_summaries/status	get a summary of jobs grouped by status
GET	/datasets/<dataset_id>/job_counts/status	get a count of jobs grouped by status

Jobs (internal use only)

Method	Path	Description
POST	/jobs	create a job
GET	/jobs/<job_id>	get a job
PATCH	/jobs/<job_id>	update a job

Tasks

Method	Path	Description
GET	/datasets/<dataset_id>/tasks	get a list of tasks, filtered by dataset_id, job_id, grid_id
GET	/datasets/<dataset_id>/tasks/<task_id>	get a task
PUT	/datasets/<dataset_id>/tasks/<task_id>/status	set a task status
GET	/datasets/<dataset_id>/task_summaries/status	get a summary of tasks grouped by status
GET	/datasets/<dataset_id>/task_counts/status	get a count of tasks grouped by status
GET	/datasets/<dataset_id>/task_counts/name_status	get a count of tasks grouped by name and status
POST	/datasets/<dataset_id>/task_actions/bulk_status/<status>	set a task status in bulk
PATCH	/datasets/<dataset_id>/task_actions/bulk_requirements/<name>	set a task requirement in bulk, by task name
GET	/datasets/<dataset_id>/task_stats	get simple stats for a dataset
GET	/datasets/<dataset_id>/files	get all the files in a dataset
POST	/datasets/<dataset_id>/files	add a file to a dataset, specifying url, job, task name
GET	/datasets/<dataset_id>/files/<task_id>	get files for a task
POST	/datasets/<dataset_id>/files/<task_id>	add a file to a task
DELETE	/datasets/<dataset_id>/files/<task_id>	delete all files from a task

Tasks (internal use only)

Method	Path	Description
POST	/tasks	create a task
GET	/tasks/<task_id>	get a task
PATCH	/tasks/<task_id>	update a task
POST	/tasks/<task_id>/task_actions/reset	reset a task
POST	/tasks/<task_id>/task_actions/complete	complete a task
POST	/task_actions/queue	queue some tasks
POST	/task_actions/process	process some tasks

Task Stats

Method	Path	Description
GET	/datasets/<dataset_id>/tasks/<task_id>/task_stats	get a list of task stats
GET	/datasets/<dataset_id>/tasks/<task_id>/task_stats/<task_stat_id>	get a task stat

Task Stats (internal use only)

Method	Path	Description
POST	/tasks/<task_id>/task_stats	create a task stat

Logs

Method	Path	Description
POST	/datasets/<dataset_id>/logs	create a log
GET	/datasets/<dataset_id>/logs/<log_id>	get a log
GET	/datasets/<dataset_id>/tasks/<task_id>/logs	get logs for a dataset and task

Logs (internal use only)

Method	Path	Description
POST	/logs	create a log
GET	/logs/<log_id>	get a log

Grids

Method	Path	Description
GET	/grids	get a list of grids
POST	/grids	create a new grid
GET	/grids/<grid_id>	get a grid

Pilots

Method	Path	Description
GET	/pilots	get a list of pilots, filtered by grid_id
POST	/pilots	create a pilot
GET	/pilots/<pilot_id>	get a pilot
PATCH	/pilots/<pilot_id>	update a pilot
DELETE	/pilots/<pilot_id>	delete a pilot

Auth

Method	Path	Description
GET	/roles	get a list of roles
PUT	/roles/<role_name>	create a role
GET	/roles/<role_name>	get a role
DELETE	/roles/<role_name>	delete a role
GET	/groups	get a list of groups
POST	/groups	add a group
GET	/groups/<group_id>	get a group
DELETE	/groups/<group_id>	delete a group
GET	/users	get a list of users
POST	/users	add a user
GET	/users/<user_id>	get a user
DELETE	/users/<user_id>	delete a user
GET	/users/<user_id>/groups	get the groups for a user
POST	/users/<user_id>/groups	add a group to a user
PUT	/users/<user_id>/groups	set the groups for a user
PUT	/users/<user_id>/roles	set the roles for a user
POST	/ldap	create a token from an LDAP username/password lookup
POST	/create_token	create a token from another token

Internal auth

Method	Path	Description
PUT	/auths/<dataset_id>	set authorization rules for dataset
GET	/auths/<dataset_id>	get authorization rules for dataset
GET	/auths/<dataset_id>/actions/read	does the current token have read access to this dataset?
GET	/auths/<dataset_id>/actions/write	does the current token have write access to this dataset?