Quark V1 API Documentation

Introduction

Welcome to Quark V1 API documentation.

Quark APIs are completely RESTful, accept form-encoded request bodies, return JSON-encoded responses, and use standard HTTP response codes, authentication methods, and verbs.

Jobs

Create Job Run

This API is used to create a job run within a specific project.

Request

  • Method: POST

  • URL: {{BASE_URL}}/api/v1/projects/:project/jobruns

  • Description: This endpoint is used to create a job run within a specific project.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to create a job run.

Request Body

The API request JSON fields are as mentioned below:

Parameter Type Description
data object An object containing request info for creating a job run.
data.name string User-defined name for job run.
data.desc string User-defined value of description, providing additional context.
data.spec object Specification of the job run resource, detailing its configuration and references.
data.spec.props object Properties related to the job run file.
data.spec.props.file.originalName string The original name of the file being processed.
data.spec.props.file.name string The name of the file to be processed.
data.spec.props.file.id string Unique identifier for the file.Unique identifier for the file.
data.spec.props.file.extn string The file extension of the file being processed.
data.spec.parameters object Parameters for the job run configuration.
data.spec.parameters.file string The name of the file parameter.
data.spec.parameters.default.cpu string Default amount of CPU requested for the job run.
data.spec.parameters.default.memory string Default amount of memory requested for the job run.
data.spec.compute string Compute resource specification.
data.spec.templateRef object Reference to the template used for the job run creation.
data.spec.templateRef.apiVersion string API version of the template.
data.spec.templateRef.kind string The kind of the template.
data.spec.templateRef.name string The name of the template being referenced.

The API request JSON schema is mentioned below:

{
    "data": {
        "name": "",
        "spec": {
            "props": {
                "file.originalName": "",
                "file.name": "",
                "file.id": "",
                "file.extn": ".fasta"
            },
            "parameters": {
                "file": "",
                "default.cpu": "8",
                "default.memory": "31"
            },
            "compute": "",
            "templateRef": {
                "apiVersion": "",
                "kind": "GlobalJobTemplate",
                "name": ""
            }
        }
    }
}

Response

  • Status: 200

  • Description: Successfully created a job run.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false)
status.msg string A message providing additional context about the request status

The API response JSON schema as mentioned below:

{    "status": {        "ok": true,        "msg": "ok"    }}

Request Headers

  • content-type: application/json

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X POST -H "content-type:  application/json" -d '{
    "data": {
        "name": "btch-singlejobrun",
        "spec": {
            "props": {
                "file.originalName": "example.fasta",
                "file.name": "123.fasta",
                "file.id": "123",
                "file.extn": ".fasta"
            },
            "parameters": {
                "file": "123.fasta",
                "default.cpu": "8",
                "default.memory": "31"
            },
            "compute": "",
            "templateRef": {
                "apiVersion": "",
                "kind": "GlobalJobTemplate",
                "name": ""
            }
        }
    }
}' "{{BASE_URL}}/api/v1/projects/:project/jobruns"
POST {{BASE_URL}}/api/v1/projects/:project/jobruns HTTP/1.1
content-type:  application/json

{
    "data": {
        "name": "btch-singlejobrun",
        "spec": {
            "props": {
                "file.originalName": "example.fasta",
                "file.name": "123.fasta",
                "file.id": "123",
                "file.extn": ".fasta"
            },
            "parameters": {
                "file": "123.fasta",
                "default.cpu": "8",
                "default.memory": "31"
            },
            "compute": "",
            "templateRef": {
                "apiVersion": "",
                "kind": "GlobalJobTemplate",
                "name": ""
            }
        }
    }
}

List Job Runs

This API is used to retrieve a list of all the job runs on the run screen.

Request

  • Method: GET

  • Endpoint: {{BASE_URL}}/api/v1/projects/:project/jobruns

  • Description: This endpoint is used to retrieve a list of all the job runs on the run screen.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to retrieve the list of job runs.

Response

  • Status: 200

  • Description: Successfully retrieved list of job runs.

Response Body

The API returns a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.
data object An object containing the job run items.
data.items list An array of job run items.
data.items[].id string The ID of the job run item.
data.items[].name string The name of the job run item.
data.items[].namespace string The namespace of the job run item.
data.items[].spec object An object containing the specifications of the job run item, with the following fields:
data.items[].spec.templateRef object Reference to the template used for the job run resource creation.
data.items[].spec.templateRef.kind string The kind of the template.
data.items[].spec.templateRef.name string The name of the template being referenced.
data.items[].spec.parameters object An object containing the parameters of the job run resource, with dynamic fields.
data.items[].spec.props object An object containig properties of job run resource.
data.items[].spec.props.file.extn string Represents different types of file and its extension.
data.items[].spec.props.file.id string Represents different types of file and its unique identifier.
data.items[].spec.props.file.name string Represents different types of file and its name.
data.items[].spec.props.file.originalName string Represents different types of file and its original name.
data.items[].platform boolean A boolean indicating if the job run resource is a platform.
data.items[].imported boolean A boolean indicating if the job run resource is imported.
data.items[].age string Represents age of the job run resource.
data.items[].createdBy string User who created the resource.
data.items[].createdAt number The timestamp of the creation of the job run item.
data.items[].updatedAt number The timestamp of the last update of the job run item.
data.items[].status object An object containing the status of the job run item.
data.items[].status.ready object Indicates the readiness status.
data.items[].status.ready.status string Status of readiness.
data.items[].status.sync object Indicates the synchronization status.
data.items[].status.sync.status string Status of synchroniszation.
data.items[].status.output object An object containing the output details.
data.items[].status.output.artifactURI string The URI of the artifact.
data.items[].status.output.completed boolean A boolean indicating if the job run is completed.
data.items[].status.output.endpoint string The endpoint of the job run.
data.items[].status.output.endpoints object An object containing the endpoints, with fields “observability”.
data.items[].status.output.externalID string The external ID of the job run.
data.items[].status.output.finishedAt number The timestamp of the completion of the job run.
data.items[].status.output.inputURI string The URI of the input.
data.items[].status.output.startedAt number The timestamp of the start of the job run.
data.items[].status.output.state string The state of the job run.
data.items[].status.output.totalRuntime string The total runtime of the job run.
data.items[].status.status string The status of the job run item.
data.items[].status.clusterEndpoint string The cluster endpoint of the job run item.

The API response JSON schema as mentioned below:

{
    "status": {
        "ok": true,
        "msg": "ok"
    },
    "data": {
        "items": [
            {
                "id": "",
                "name": "",
                "namespace": "",
                "spec": {
                    "templateRef": {
                        "kind": "GlobalJobTemplate",
                        "name": ""
                    },
                    "parameters": {},
                    "props":{}
                },
                "platform": false,
                "imported": false,
                "createdBy": “”,
                "createdAt": 1721305036000,
                "updatedAt": 1721305036000,
                "status": {
                    "ready": {},
                    "sync": {},
                    "output": {
                        "artifactURI": "",
                        "completed": true,
                        "endpoint": "",
                        "endpoints": {
                            "observability": ""
                        },
                        "externalID": "",
                        "finishedAt": 1721305144000,
                        "inputURI": "",
                        "startedAt": 1721305129000,
                        "state": "Success",
                        "totalRuntime": "15s"
                    },
                    "status": "Success",
                    "clusterEndpoint": ""
                }
            }
        ]
    }
}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X GET "{{BASE_URL}}/api/v1/projects/:project/jobruns"
GET {{BASE_URL}}/api/v1/projects/:project/jobruns HTTP/1.1

Get Job Run

This API retrieves information about a specific job run within a specific project.

Request

  • Method: GET

  • URL: {{BASE_URL}}/api/v1/projects/:project/jobruns/:id

  • Description: This endpoint retrieves information about a specific job run within a specific project.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to retrieve info about specific job runs.
id path variable This represents a specific job run id.

Response

  • Status: 200

  • Description: Successfully retrieved info about specific job run.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.
data object An object containing response data.
data.id string Unique identifier of the job run.
data.name string Name of the job run.
data.namespace string Namespace of the job run.
data.spec object Object containing specifications of the job run.
data.spec.templateRef object Reference to the template used.
data.spec.templateRef.kind string Kind of the template.
data.spec.templateRef.name string Name of the template used.
data.spec.parameters object Object containing dynamic input parameters for the job run.
data.spec.props object An object containing job run properties.
data.spec.props.file.extn string Represents different types of file and its extension.
data.spec.props.file.id string Represents different types of file and its unique identifier.
data.spec.props.file.name string Represents different types of file and its name.
data.spec.props.file.originalName string Represents different types file and its original name.
data.spec.platform boolean Indicates if the job run is platform-based.
data.spec.imported boolean Indicates if the job run is imported.
data.spec.age string Age of the job run resource.
data.spec.createdBy string User who created the job run.
data.spec.createdAt number Timestamp of creation.
data.spec.updatedAt number Timestamp of last updation.
data.spec.status object Object containing status information of the job run.
data.spec.status.ready object Indicates if the resource is ready.
data.spec.status.ready.status string Status of readiness.
data.spec.status.sync object Indicates if the resource is synced.
data.spec.status.sync.status string Status of sync.
data.spec.status.output object Object containing output status.
data.spec.status.output.artifactURI string URI of the output artifact.
data.spec.status.output.completed boolean Indicates if the job run is completed.
data.spec.status.output.endpoint string Endpoint of the job run.
data.spec.status.output.endpoints object Object containing endpoints information.
data.spec.status.output.endpoints.observability string Represents job run observability endpoint.
data.spec.status.output.externalID string External ID of the job run.
data.spec.status.output.finishedAt number Timestamp of job run completion.
data.spec.status.output.inputURI string URI of the input.
data.spec.status.output.startedAt number Timestamp of job run start.
data.spec.status.output.state string State of the job run.
data.spec.status.output.totalRuntime string Total runtime of the job run.
data.spec.status.status string Status of the job run.
data.spec.status.clusterEndpoint string Endpoint of the cluster.

The API response JSON object schema is as mentioned below:

{
    "status": {
        "ok": true,
        "msg": "ok"
    },
    "data": {
        "id": "bactmap-run-2",
        "name": "bactmap-run-2",
        "namespace": "",
        "spec": {
            "templateRef": {
                "kind": "GlobalJobTemplate",
                "name": ""
            },
            "parameters": {}
        },
        "platform": false,
        "imported": false,
        "createdBy": "",
        "createdAt": 0,
        "updatedAt": 0,
        "status": {
            "ready": {},
            "sync": {},
            "output": {
                "artifactURI": "",
                "completed": false,
                "endpoint": "",
                "endpoints": {
                    "observability": ""
                },
                "externalID": "",
                "finishedAt": 0,
                "inputURI": "",
                "startedAt": 0,
                "state": "",
                "totalRuntime": ""
            },
            "status": "",
            "clusterEndpoint": ""
        }
    }
}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X GET "{{BASE_URL}}/api/v1/projects/:project/jobruns/:id"
GET {{BASE_URL}}/api/v1/projects/:project/jobruns/:id HTTP/1.1

Delete Job Run

This API is used to delete a job run resource based on id.

Request

  • Method: DELETE

  • URL: {{BASE_URL}}/api/v1/projects/:project/jobruns/:id

  • Description: This endpoint is used to delete a job run resource based on id.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to delete a job run resource based on id.
id path variable This represents a job run resource id.

Response

  • Status: 200

  • Description: Successfully deleted a job run resource.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.

The API response JSON schema as mentioned below:

{    "status": {        "ok": true,        "msg": "ok"    }}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X DELETE "{{BASE_URL}}/api/v1/projects/:project/jobruns/:id"
DELETE {{BASE_URL}}/api/v1/projects/:project/jobruns/:id HTTP/1.1

Download Job Run Result

This API is used to download job run result.

Request

  • Method: POST

  • URL: {{BASE_URL}}/api/v1/projects/:project/settings/inputs/downloadurl?path=&kind=jobrun&id=

  • Description: This endpoint is used to download job run result.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which for to download job run result.
id query This represents a job run id.
path query This represents the file path.

Response

  • Status: 200

  • Description: Successfully downloaded job run result.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.
data object Contains the main data returned by the API.
data.url string Contains url to download the result.

The API response JSON schema as mentioned below:

{
    "status": {
        "ok": true,
        "msg": "ok"
    },
    "data": {
        "url": "<url for downloading result>"
    }
}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X POST "{{BASE_URL}}/api/v1/projects/:project/settings/inputs/downloadurl?path=predictions/features.pkl&kind=jobrun&id="
POST {{BASE_URL}}/api/v1/projects/:project/settings/inputs/downloadurl?path=predictions/features.pkl&kind=jobrun&id= HTTP/1.1

Terminate Job Run

This API is used to terminate a job run resource based on id.

Request

  • Method: POST

  • URL: {{BASE_URL}}/api/v1/projects/:project/jobruns/:id/terminate

  • Description: This endpoint is used to terminate a job run resource based on id.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to delete a job run resource based on id.
id path variable This represents a job run resource id.

Response

  • Status: 200

  • Description: Successfully terminated a job run resource.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.

The API response JSON schema as mentioned below:

{    "status": {        "ok": true,        "msg": "ok"    }}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X POST "{{BASE_URL}}/api/v1/projects/:project/jobruns/:id/terminate"
POST {{BASE_URL}}/api/v1/projects/:project/jobruns/:id/terminate HTTP/1.1

List Job Templates

This API endpoint retrieves a list of all the job templates in Launchpad.

Request

  • Method: GET

  • Endpoint: {{BASE_URL}}/api/v1/projects/:project/jobtemplates

  • Description: This endpoint retrieves a list of all the job templates in Launchpad.
    Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to retrieve list of job templates.

Response

  • Status: 200

  • Description: Successfully retrieved the list of job templates.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.
data object An object containing the list of job templates.
data.items list An array of job template objects.
data.items[].id string The ID of the job template.
data.items[].name string The name of the job template.
data.items[].spec object An object containing the specifications of the job template.
data.items[].spec.image object An object containing the image specifications.
data.items[].spec.image.env object An object containing environment variables for the job template.
data.items[].spec.image.imageRef object An object containing the reference to the image.
data.items[].spec.image.imageRef.name string Image reference name.
data.items[].spec.image.profileRef object An object containing the reference to the profile.
data.items[].spec.image.profileRef.name string Profile reference name.
data.items[].spec.image.extraArgs list An array of extra arguments for the image.
data.items[].spec.props object An object containing additional properties for the job template.
data.items[].spec.type string The type of the job template.
data.items[].spec.code object An object containing the code specifications.
data.items[].spec.code.source string Origin or location of the code.
data.items[].spec.code.git object An object created based on code source.
data.items[].spec.code.git.repo string Source code repo url.
data.items[].spec.code.git.revision string Source code repo revision.
data.items[].spec.capacity object An object containing the capacity specifications.
data.items[].spec.capacity.gpu boolean Represent whether gpu is enabled or not.
data.items[].spec.objectstores list A list of object store specifications.
data.items[].spec.objectstores[].name string The name of the object store
data.items[].spec.objectstores[].desc string A description of the object store
data.items[].spec.objectstores[].resourceSelector object An object defining the criteria for selecting resources.
data.items[].spec.objectstores[].resourceSelector.ref object A reference object used for selecting resources.
data.items[].spec.objectstores[].resourceSelector.ref.name string The name of the referenced resource.
data.items[].spec.objectstores[].resourceSelector.matchLabels object Labels used for matching resources.
data.items[].spec.objectstores[].resourceSelector.kind string The kind of resource being referenced.
data.items[].spec.parameters list A list of parameters for the job template.
data.items[].spec.parameters[].name string The name of the parameter.
data.items[].spec.parameters[].type string The type of the parameter.
data.items[].spec.parameters[].props object Properties associated with the parameter.
data.items[].spec.parameters[].flags object Flags that modify the behavior of the parameter.
data.items[].spec.parameters[].flags.browse boolean A boolean indicating whether the file browser is enabled or not.
data.items[].spec.parameters[].validations list An array of validation rules for the parameter.
data.items[].spec.permissions list An array of permission objects for the services used.
data.items[].spec.permissions[].services string The name of the service for which permissions are granted.
data.items[].spec.rbac object RBAC settings for the resource.
data.items[].spec.rbac.enabled boolean indicates if RBAC is enabled or not.
data.items[].spec.rbac.rules list List of RBAC rules.
data.items[].spec.display object Indicates resource display specification.
data.items[].spec.display.name string Indicates resource display name.
data.items[].spec.display.desc string Indicates resource display description.
data.items[].spec.display.icon string Indicates resource display icon.
data.items[].spec.display.tags list List of resource associated tags.
data.items[].spec.display.labels list List of resource associated labels.
data.items[].spec.display.props object Additional properties for display.
data.items[].spec.display.files object An object containing associated files info.
data.items[].spec.launchConfigSelector object Selector for launch configuration.
data.items[].spec.launchConfigSelector.ref object Reference for the launch configuration.
data.items[].spec.launchConfigSelector.ref.name string Name of the launch configuration reference.
data.items[].spec.launchConfigSelector.matchLabels string Label used for matching launch configuration.
data.items[].spec.publishedResultTemplates list An array of published result templates.
data.items[].spec.publishedResultTemplates.kind string The kind or category of the template
data.items[].spec.publishedResultTemplates.name string The unique name of the template.
data.items[].spec.publishedResultTemplates.properties. object Properties associated with the template.
data.items[].spec.publishedResultTemplates.properties.displayName string User-defined name for display purposes.
data.items[].spec.computeEngines list An array of compute engines for the job template.
data.items[].platform boolean Indicates if the job template is for the platform
data.items[].imported boolean Indicates if the job template is imported.
data.items[].ref object An object containing the reference specifications for the job template.
data.items[].ref.apiVersion string This represent api version of the job template.
data.items[].ref.kind string This represent kind of the job template.
data.items[].ref.name string This represent name of the job template.
data.items[].createdBy string Indicates user who has created the job.
data.items.[]createdAt number The timestamp of when the job template was created.
data.items[].updatedAt number The timestamp of when the job template was last updated.
data.items[].status object An object containing the status of the job template.
data.items[].status.ready object Indicates if the resource is ready.
data.items[].status.ready.status string Status of readiness.
data.items[].status.sync object Indicates if the resource is synchronized.
data.items[].status.sync.status string Status of synchronization.

The API response JSON object schema is as mentioned below:

{
    "status": {
        "ok": true,
        "msg": "ok"
    },
    "data": {
        "items": [
            {
                "id": "airrflow-nfcore-v1",
                "name": "airrflow-nfcore-v1",
                "spec": {
                    "image": {
                        "env": {
                            "JOB_EXTRA_ARGS": ""
                        },
                        "imageRef": {
                            "name": ""
                        },
                        "profileRef": {
                            "name": ""
                        },
                        "extraArgs": [
                            "--outdir=<>",
                            "--input=<>",
                            "--profile=docker",
                            "--extra-args=env://JOB_EXTRA_ARGS"
                        ]
                    },
                    "props": {
                        "category": "Immunology",
                        "extra.nextflow.config": ""
                    },
                    "flags": {
                        "deleted": true,
                        "imported": true,
                        "published": true
                    },
                    "version": "1.2.3.4",            
                    "type": "Nextflow",
                    "code": {
                        "source": "Git",
                        "git": {
                            "repo": "https://github.com/nf-core/airrflow.git",
                            "revision": "3.2.0"
                        }
                    },
                    "capacity": {
                        "gpu": "false"
                    },
                    "objectstores": [
                        {
                            "name": "refdata-1-1",
                            "desc": "Reference Data",
                            "resourceSelector": {
                                "ref": {
                                    "name": ""
                                },
                                "matchLabels": {
                                },
                                "kind": "DataSet"
                            }
                        }
                    ],
                    "parameters": [
                        {
                            "name": "input_tsv",
                            "type": "File",
                            "props": {
                                "fileFormat": "",
                                "label": "Input TSV",
                                "upload.namePattern": "ts1"
                            },
                            "flags": {
                                "browse": false
                            },
                            "validations": [
                                {
                                    "valueFn": "extn",
                                    "type": "Enum",
                                    "enum": [
                                        ".tsv"
                                    ]
                                }
                            ]
                        }
                    ],
                    "permissions": [
                        {
                            "read": true,
                            "write": true,
                            "service": "s3"
                        }
                    ],
                    "rbac": {
                        "enabled": false,
                        "rules": null
                    },
                    "display": {
                        "name": "AIRR Flow",
                        "desc": "",
                        "icon": "nextflow",
                        "tags": [
                            {
                                "name": "",
                                "value": ""
                            }
                        ],
                        "props": {
                            "badges": "",
                            "version": ""
                        },
                        "files": {}
                    },
                    "launchConfigSelector": {
                        "ref": {
                            "name": ""
                        },
                        "matchLabels": {
                        }
                    },
                    "publishedResultTemplates": [
                        {
                            "kind": "",
                            "name": "",
                            "properties": {
                                "displayName": ""
                            }
                        }
                    ],
                    "computeEngines": [
                        "K8S"
                    ]
                },
                "platform": false,
                "imported": false,
                "ref": {
                    "apiVersion": "",
                    "kind":"",
                    "name": "",
                    "namepsace":""                                
                },
                "createdAt": 1709905170000,
                "updatedAt": 1709905170000,
                "status": {
                    "ready": {
                        "status": ""
                    },
                    "sync": {
                        "status": ""
                    }
                }
            }
       ]
    }
}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X GET "{{BASE_URL}}/api/v1/projects/:project/jobtemplates"
GET {{BASE_URL}}/api/v1/projects/:project/jobtemplates HTTP/1.1

Get Job Template

This API endpoint retrieves the information about specific job template.

Request

  • Method: GET

  • Endpoint: {{BASE_URL}}/api/v1/projects/:project/jobtemplates/:id?kind=GlobalJobTemplate

  • Description: This endpoint retrieves the info about specific job templates.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to retrieve the job runs.
id path variable This represent unique identifier for job template.

Response

  • Status: 200

  • Description: Successfully retrieved job templates info.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.
data object An object containing the list of job templates.
data.id string The ID of the job template.
data.name string The name of the job template.
data.spec object An object containing the specifications of the job template.
data.spec.image object An object containing the image specifications.
data.spec.image.env object An object containing environment variables for the job template.
data.spec.image.imageRef object An object containing the reference to the image.
data.spec.image.imageRef.name string Image reference name.
data.spec.image.profileRef object An object containing the reference to the profile.
data.spec.image.profileRef.name string Profile reference name.
data.spec.image.extraArgs list An array of extra arguments for the image.
data.spec.props object An object containing additional properties for the job template.
data.spec.type string The type of the job template.
data.spec.code object An object containing the code specifications.
data.spec.code.source string Origin or location of the code.
data.spec.code.git object An object created based on code source.
data.spec.code.git.repo string Source code repo url.
data.spec.code.git.revision string Source code repo revision.
data.spec.capacity object An object containing the capacity specifications.
data.spec.capacity.gpu boolean Represent whether gpu is enabled or not.
data.spec.objectstores list A list of object store specifications.
data.spec.objectstores[].name string The name of the object store
data.spec.objectstores[].desc string A description of the object store
data.spec.objectstores[].resourceSelector object An object defining the criteria for selecting resources.
data.spec.objectstores[].resourceSelector.ref object A reference object used for selecting resources.
data.spec.objectstores[].resourceSelector.ref.name string The name of the referenced resource.
data.spec.objectstores[].resourceSelector.matchLabels object Labels used for matching resources.
data.spec.objectstores[].resourceSelector.kind string The kind of resource being referenced.
data.spec.parameters list A list of parameters for the job template.
data.spec.parameters[].name string The name of the parameter.
data.spec.parameters[].type string The type of the parameter.
data.spec.parameters[].props object Properties associated with the parameter.
data.spec.parameters[].flags object Flags that modify the behavior of the parameter.
data.spec.parameters[].flags.browse boolean A boolean indicating whether the file browser is enabled or not.
data.spec.parameters[].validations list An array of validation rules for the parameter.
data.spec.permissions list An array of permission objects for the services used.
data.spec.permissions[].services string The name of the service for which permissions are granted.
data.spec.rbac object RBAC settings for the resource.
data.spec.rbac.enabled boolean indicates if RBAC is enabled or not.
data.spec.rbac.rules list List of RBAC rules.
data.spec.display object Indicates resource display specification.
data.spec.display.name string Indicates resource display name.
data.spec.display.desc string Indicates resource display description.
data.spec.display.icon string Indicates resource display icon.
data.spec.display.tags list List of resource associated tags.
data.spec.display.labels list List of resource associated labels.
data.spec.display.props object Additional properties for display.
data.spec.display.files object An object containing associated files info.
data.spec.launchConfigSelector object Selector for launch configuration.
data.spec.launchConfigSelector.ref object Reference for the launch configuration.
data.spec.launchConfigSelector.ref.name string Name of the launch configuration reference.
data.spec.launchConfigSelector.matchLabels string Label used for matching launch configuration.
data.spec.publishedResultTemplates list An array of published result templates.
data.spec.publishedResultTemplates.kind string The kind or category of the template
data.spec.publishedResultTemplates.name string The unique name of the template.
data.spec.publishedResultTemplates.properties. object Properties associated with the template.
data.spec.publishedResultTemplates.properties.displayName string User-defined name for display purposes.
data.spec.computeEngines list An array of compute engines for the job template.
data.platform boolean Indicates if the job template is for the platform
data.imported boolean Indicates if the job template is imported.
data.ref object An object containing the reference specifications for the job template.
data.ref.apiVersion string This represent api version of the job template.
data.ref.kind string This represent kind of the job template.
data.ref.name string This represent name of the job template.
data.createdAt number The timestamp of when the job template was created.
data.updatedAt number The timestamp of when the job template was last updated.

The API response JSON object schema is as mentioned below:

{
  "status": {
    "ok": true,
    "msg": "ok"
  },
  "data": {
    "id": "airrflow-nfcore-v1",
    "name": "airrflow-nfcore-v1",
    "spec": {
      "image": {
        "env": {
          "JOB_EXTRA_ARGS": ""
        },
        "imageRef": {
          "name": ""
        },
        "profileRef": {
          "name": ""
        },
        "extraArgs": [
          "--outdir=<>",
          "--input=<>",
          "--profile=docker",
          "--extra-args=env://JOB_EXTRA_ARGS"
        ]
      },
      "props": {
        "category": "Immunology",
        "extra.nextflow.config": ""
      },
      "flags": {
        "deleted": true,
        "imported": true,
        "published": true
      },
      "version": "1.2.3.4",
      "type": "Nextflow",
      "code": {
        "source": "Git",
        "git": {
          "repo": "https://github.com/nf-core/airrflow.git",
          "revision": "3.2.0"
        }
      },
      "capacity": {
        "gpu": "false"
      },
      "objectstores": [
        {
          "name": "refdata-1-1",
          "desc": "Reference Data",
          "resourceSelector": {
            "ref": {
              "name": ""
            },
            "matchLabels": {
            },
            "kind": "DataSet"
          }
        }
      ],
      "parameters": [
        {
          "name": "input_tsv",
          "type": "File",
          "props": {
            "fileFormat": "",
            "label": "Input TSV",
            "upload.namePattern": "ts1"
          },
          "flags": {
            "browse": false
          },
          "validations": [
            {
              "valueFn": "extn",
              "type": "Enum",
              "enum": [
                ".tsv"
              ]
            }
          ]
        }
      ],
      "permissions": [
        {
          "read": true,
          "write": true,
          "service": "s3"
        }
      ],
      "rbac": {
        "enabled": false,
        "rules": null
      },
      "display": {
        "name": "AIRR Flow",
        "desc": "",
        "icon": "nextflow",
        "tags": [
          {
            "name": "",
            "value": ""
          }
        ],
        "props": {
          "badges": "",
          "version": ""
        },
        "files": {}
      },
      "launchConfigSelector": {
        "ref": {
          "name": ""
        },
        "matchLabels": {
        }
      },
      "publishedResultTemplates": [
        {
          "kind": "",
          "name": "",
          "properties": {
            "displayName": ""
          }
        }
      ],
      "computeEngines": [
        "K8S"
      ]
    },
    "platform": false,
    "imported": false,
    "ref": {
      "apiVersion": "",
      "kind": "",
      "name": "",
      "namepsace": ""
    },
    "createdAt": 1709905170000,
    "updatedAt": 1709905170000,
    "status": {
      "ready": {
        "status": ""
      },
      "sync": {
        "status": ""
      }
    }
  }
}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X GET "{{BASE_URL}}/api/v1/projects/:project/jobtemplates/:id?kind=GlobalJobTemplate"
GET {{BASE_URL}}/api/v1/projects/:project/jobtemplates/:id?kind=GlobalJobTemplate HTTP/1.1

Create Batch Job Run

This API is used to create a batch job run within a specific project.

Request

  • Method: POST

  • URL: {{BASE_URL}}/api/v1/projects/:project/jobruns

  • Description: This endpoint is used to create a batch job run within a specific project.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to create a batch job run.

Request Body

The API request JSON fields are as mentioned below:

Parameter Type Description
data object An object containing request info for creating a batch job run.
data.name string User-defined name for batch job run.
data.desc string User-defined value of description, providing additional context.
data.spec object Specification of the job run resource, detailing its configuration and references.
data.spec.props object Properties related to the job run file.
data.spec.props.file.originalName string The original name of the file being processed.
data.spec.props.file.name string The name of the file to be processed.
data.spec.props.file.id string Unique identifier for the file.Unique identifier for the file.
data.spec.props.file.extn string The file extension of the file being processed.
data.spec.parameters object Parameters for the job run configuration.
data.spec.parameters.file string The name of the file parameter.
data.spec.parameters.default.cpu string Default amount of CPU requested for the job run.
data.spec.parameters.default.memory string Default amount of memory requested for the job run.
data.spec.compute string Compute resource specification.
data.spec.templateRef object Reference to the template used for the job run creation.
data.spec.templateRef.apiVersion string API version of the template.
data.spec.templateRef.kind string The kind of the template.
data.spec.templateRef.name string The name of the template being referenced.

The API request JSON schema is mentioned below:

{
    "data": {
        "name": "",
        "spec": {
            "props": {
                "file.originalName": "",
                "file.name": "",
                "file.id": "",
                "file.extn": ".zip"
            },
            "parameters": {
                "file": "",
                "default.cpu": "8",
                "default.memory": "31"
            },
            "compute": "",
            "templateRef": {
                "apiVersion": "",
                "kind": "GlobalBatchJobTemplate",
                "name": ""
            }
        }
    }
}

Response

  • Status: 200

  • Description: Successfully created a job run.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false)
status.msg string A message providing additional context about the request status

The API response JSON schema as mentioned below:

{    "status": {        "ok": true,        "msg": "ok"    }}

Request Headers

  • content-type: application/json

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X POST -H "content-type: application/json" -d '{
    "data": {
        "name": "test",
        "spec": {
            "props": {
                "file.originalName": "example.zip",
                "file.name": "123.zip",
                "file.id": "123",
                "file.extn": ".zip"
            },
            "parameters": {
                "file": "123.zip",
                "default.cpu": "8",
                "default.memory": "31"
            },
            "compute": "",
            "templateRef": {
                "apiVersion": "",
                "kind": "GlobalBatchJobTemplate",
                "name": ""
            }
        }
    }
}' "{{BASE_URL}}/api/v1/projects/:project/jobruns"
POST {{BASE_URL}}/api/v1/projects/:project/jobruns HTTP/1.1
content-type: application/json

{
    "data": {
        "name": "test",
        "spec": {
            "props": {
                "file.originalName": "example.zip",
                "file.name": "123.zip",
                "file.id": "123",
                "file.extn": ".zip"
            },
            "parameters": {
                "file": "123.zip",
                "default.cpu": "8",
                "default.memory": "31"
            },
            "compute": "",
            "templateRef": {
                "apiVersion": "",
                "kind": "GlobalBatchJobTemplate",
                "name": ""
            }
        }
    }
}

List Batch Job Runs

This API is used to retrieve a list of all the batch job runs on the batch run screen.

Request

  • Method: GET

  • Endpoint: {{BASE_URL}}/api/v1/projects/:project/batchjobruns

  • Description: This endpoint is used to retrieve a list of all the batch job runs on the batch run screen.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to retrieve the list of batch job runs.

Response

  • Status: 200

  • Description: Successfully retrieved list of batch job runs.

Response Body

The API returns a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.
data object An object containing the batch job run items.
data.items list An array of batch job run items.
data.items[].id string The ID of the batch job run item.
data.items[].name string The name of the batch job run item.
data.items[].namespace string The namespace of the batch job run item.
data.items[].spec object An object containing the specifications of the batch job run item, with the following fields:
data.items[].spec.templateRef object Reference to the template used for the batch job run resource creation.
data.items[].spec.templateRef.kind string The kind of the template.
data.items[].spec.templateRef.name string The name of the template being referenced.
data.items[].spec.parameters object An object containing the parameters of the batch job run resource, with dynamic fields.
data.items[].spec.props object An object containig properties of batch job run resource.
data.items[].spec.props.file.extn string Represents different types of file and its extension.
data.items[].spec.props.file.id string Represents different types of file and its unique identifier.
data.items[].spec.props.file.name string Represents different types of file and its name.
data.items[].spec.props.file.originalName string Represents different types of file and its original name.
data.items[].platform boolean A boolean indicating if the batch job run resource is a platform.
data.items[].imported boolean A boolean indicating if the batch job run resource is imported.
data.items[].age string Represents age of the batch job run resource.
data.items[].createdBy string User who created the resource.
data.items[].createdAt number The timestamp of the creation of the batch job run item.
data.items[].updatedAt number The timestamp of the last update of the batch job run item.
data.items[].status object An object containing the status of the batch job run item.
data.items[].status.ready object Indicates the readiness status.
data.items[].status.ready.status string Status of readiness.
data.items[].status.sync object Indicates the synchronization status.
data.items[].status.sync.status string Status of synchroniszation.
data.items[].status.output object An object containing the output details.
data.items[].status.output.artifactURI string The URI of the artifact.
data.items[].status.output.completed boolean A boolean indicating if the batch job run is completed.
data.items[].status.output.endpoint string The endpoint of the batch job run.
data.items[].status.output.endpoints object An object containing the endpoints, with fields “observability”.
data.items[].status.output.externalID string The external ID of the batch job run.
data.items[].status.output.finishedAt number The timestamp of the completion of the batch job run.
data.items[].status.output.inputURI string The URI of the input.
data.items[].status.output.startedAt number The timestamp of the start of the batch job run.
data.items[].status.output.state string The state of the batch job run.
data.items[].status.output.totalRuntime string The total runtime of the batch job run.
data.items[].status.status string The status of the batch job run item.
data.items[].status.clusterEndpoint string The cluster endpoint of the batch job run item.

The API response JSON schema as mentioned below:

{
    "status": {
        "ok": true,
        "msg": "ok"
    },
    "data": {
        "items": [
            {
                "id": "",
                "name": "",
                "namespace": "",
                "spec": {
                    "templateRef": {
                        "kind": "GlobalJobTemplate",
                        "name": ""
                    },
                    "parameters": {},
                    "props":{}
                },
                "platform": false,
                "imported": false,
                "createdBy": “”,
                "createdAt": 1721305036000,
                "updatedAt": 1721305036000,
                "status": {
                    "ready": {},
                    "sync": {},
                    "output": {
                        "artifactURI": "",
                        "completed": true,
                        "endpoint": "",
                        "endpoints": {
                            "observability": ""
                        },
                        "externalID": "",
                        "finishedAt": 1721305144000,
                        "inputURI": "",
                        "startedAt": 1721305129000,
                        "state": "Success",
                        "totalRuntime": "15s"
                    },
                    "status": "Success",
                    "clusterEndpoint": ""
                }
            }
        ]
    }
}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X GET "{{BASE_URL}}/api/v1/projects/:project/batchjobruns"
GET {{BASE_URL}}/api/v1/projects/:project/batchjobruns HTTP/1.1

Get Batch Job Run

This API retrieves information about a specific batch job run within a specific project.

Request

  • Method: GET

  • URL: {{BASE_URL}}/api/v1/projects/:project/batchjobruns/:id

  • Description: This endpoint retrieves information about a specific batch job run within a specific project.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to retrieve info about specific batch job runs.
id path variable This represents a specific batch job run id.

Response

  • Status: 200

  • Description: Successfully retrieved info about specific batch job run.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.
data object An object containing response data.
data.id string Unique identifier of the batch job run.
data.name string Name of the batch job run.
data.namespace string Namespace of the batch job run.
data.spec object Object containing specifications of the batch job run.
data.spec.templateRef object Reference to the template used.
data.spec.templateRef.kind string Kind of the template.
data.spec.templateRef.name string Name of the template used.
data.spec.parameters object Object containing dynamic input parameters for the batch job run.
data.spec.props object An object containing batch job run properties.
data.spec.props.file.extn string Represents different types of file and its extension.
data.spec.props.file.id string Represents different types of file and its unique identifier.
data.spec.props.file.name string Represents different types of file and its name.
data.spec.props.file.originalName string Represents different types file and its original name.
data.spec.platform boolean Indicates if the batch job run is platform-based.
data.spec.imported boolean Indicates if the batch job run is imported.
data.spec.age string Age of the job run resource.
data.spec.createdBy string User who created the batch job run.
data.spec.createdAt number Timestamp of creation.
data.spec.updatedAt number Timestamp of last updation.
data.spec.status object Object containing status information of the batch job run.
data.spec.status.ready object Indicates if the resource is ready.
data.spec.status.ready.status string Status of readiness.
data.spec.status.sync object Indicates if the resource is synced.
data.spec.status.sync.status string Status of sync.
data.spec.status.output object Object containing output status.
data.spec.status.output.artifactURI string URI of the output artifact.
data.spec.status.output.completed boolean Indicates if the batch job run is completed.
data.spec.status.output.endpoint string Endpoint of the batch job run.
data.spec.status.output.endpoints object Object containing endpoints information.
data.spec.status.output.endpoints.observability string Represents batch job run observability endpoint.
data.spec.status.output.externalID string External ID of the batch job run.
data.spec.status.output.finishedAt number Timestamp of batch job run completion.
data.spec.status.output.inputURI string URI of the input.
data.spec.status.output.startedAt number Timestamp of batch job run start.
data.spec.status.output.state string State of the batch job run.
data.spec.status.output.totalRuntime string Total runtime of the batch job run.
data.spec.status.status string Status of the batch job run.
data.spec.status.clusterEndpoint string Endpoint of the cluster.

The API response JSON object schema is as mentioned below:

{
    "status": {
        "ok": true,
        "msg": "ok"
    },
    "data": {
        "id": "bactmap-run-2",
        "name": "bactmap-run-2",
        "namespace": "",
        "spec": {
            "templateRef": {
                "kind": "GlobalBatchJobTemplate",
                "name": ""
            },
            "parameters": {}
        },
        "platform": false,
        "imported": false,
        "createdBy": "",
        "createdAt": 0,
        "updatedAt": 0,
        "status": {
            "ready": {},
            "sync": {},
            "output": {
                "artifactURI": "",
                "completed": false,
                "endpoint": "",
                "endpoints": {
                    "observability": ""
                },
                "externalID": "",
                "finishedAt": 0,
                "inputURI": "",
                "startedAt": 0,
                "state": "",
                "totalRuntime": ""
            },
            "status": "",
            "clusterEndpoint": ""
        }
    }
}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X GET  "{{BASE_URL}}/api/v1/projects/:project/batchjobruns/:id"
GET {{BASE_URL}}/api/v1/projects/:project/batchjobruns/:id HTTP/1.1

Results

Create Published Result

This API is used to publish a job run resource.

Request

  • Method: POST

  • URL: {{BASE_URL}}/api/v1/projects/:project/publishedresults

  • Description: This endpoint is used to publish a job run resource.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to publish job run resources.

Request Body

The API request JSON fields are as mentioned below:

Parameter Type Description
data object An object containing request info for publishing a job run.
data.name string User-defined name for job run.
data.desc string User-defined name of description, providing additional context.
data.spec object Specification of the job run, detailing its configuration and references.
data.spec.templateRef object Reference to the template used for the job run.
data.spec.templateRef.kind string The kind of the template.
data.spec.templateRef.name string The name of the template being referenced for the job run.
data.spec.resourceRef object Reference to the resource associated with the job run.
data.spec.resourceRef.name string The name of the resource being referenced.
data.spec.resourceRef.kind string The kind of the resource.
data.spec.resourceRef.namespace string The namespace in which the resource is located.

Response

  • Status: 200

  • Description: Successfully published a job run resource.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false)
status.msg string A message providing additional context about the request status

The API response JSON schema as mentioned below:

{    "status": {        "ok": true,        "msg": "ok"    }}

Request Headers

  • content-type: application/json

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X POST -H "content-type: application/json" -d '{
    "data": {
        "name": "",
        "desc": "batchtest",
        "spec": {
            "templateRef": {
                "kind": "Global",
                "name": ""
            },
            "resourceRef": {
                "name": "",
                "kind": "JobRun",
                "namespace": ""
            }
        }
    }
}' "{{BASE_URL}}/api/v1/projects/:project/publishedresults"
POST {{BASE_URL}}/api/v1/projects/:project/publishedresults HTTP/1.1
content-type: application/json

{
    "data": {
        "name": "6",
        "desc": "batchtest",
        "spec": {
            "templateRef": {
                "kind": "Global",
                "name": ""
            },
            "resourceRef": {
                "name": "",
                "kind": "JobRun",
                "namespace": ""
            }
        }
    }
}

List Published Results

The API fetches and returns a list of all published job runs.

Request

  • Method: GET

  • Endpoint: {{BASE_URL}}/api/v1/projects/:project/publishedresults

  • Description: This endpoint fetches and returns a list of all published job runs.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

This API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to retrieve the published job runs.

Response

  • Status: 200

  • Description: Successfully retrieved list of published job runs.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.
data object An object containing published job run items list.
data.items list List of published job run items.
data.items[].id string Unique identifier for the job run.
data.items[].desc string Description of the job run.
data.items[].spec object Specification details of the job run.
data.items[].spec.templateRef object Reference to the template used.
data.items[].spec.templateRef.kind string Kind of the template (e.g., Global).
data.items[].spec.templateRef.name string Name of the template used.
data.items[].spec.resourceRef object Reference to the resource used.
data.items[].spec.resourceRef.kind string Kind of the resource (e.g., JobRun).
data.items[].spec.resourceRef.name string Name of the resource used.
data.items[].spec.resourceRef.namespace string Namespace of the resource.
data.items[].platform boolean Indicates if the job run is platform-based.
data.items[].imported boolean Indicates if the job run was imported.
data.items[].createdBy string User who created the job run.
data.items[].createdAt number Timestamp of when the job run was created.
data.items[].updatedAt number Timestamp of when the job run was updated.
data.items[].status object Status details of the job run.
data.items[].status.ready object Indicates if the job run is ready.
data.items[].status.sync object Indicates synchronization status.
data.items[].status.output object Output details of the job run.
data.items[].status.output.endpoint string Endpoint for the job run output.
data.items[].status.status string Current status of the job run (e.g., Error).

The API response JSON schema is as mentioned below:

{
  "status": {
    "ok": true,
    "msg": "ok"
  },
  "data": {
    "items": [
      {
        "id": "string",
        "name": "string",
        "desc": "string",
        "spec": {
          "templateRef": {
            "kind": "string",
            "name": "string"
          },
          "resourceRef": {
            "kind": "string",
            "name": "string",
            "namespace": "string"
          }
        },
        "platform": false,
        "imported": false,
        "createdBy": "string",
        "createdAt": 0,
        "updatedAt": 0,
        "status": {
          "ready": {},
          "sync": {},
          "output": {
            "endpoint": "string"
          },
          "status": "string"
        }
      }
    ]
  }
}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X GET "{{BASE_URL}}/api/v1/projects/:project/publishedresults"
GET {{BASE_URL}}/api/v1/projects/:project/publishedresults HTTP/1.1

Get Published Result

The API fetches and returns a specific published job run based on id.

Request

  • Method: GET

  • Endpoint: {{BASE_URL}}/api/v1/projects/:project/publishedresults/:id

  • Description: This endpoint fetches and returns a published job run.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to retrieve a published job run.
id path variable This represents a unique identifier for published job run.

Response

  • Status: 200

  • Description: Successfully retrieved a published job run.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.
data object An object containing published job run items list.
data.id string Unique identifier for the job run.
data.name string Name of the job run.
data..desc string Description of the job run.
data.spec object Specification details of the job run.
data.spec.templateRef object Reference to the template used.
data.spec.templateRef.kind string Kind of the template (e.g., Global).
data.spec.templateRef.name string Name of the template used.
data.spec.resourceRef object Reference to the resource used.
data.spec.resourceRef.kind string Kind of the resource (e.g., JobRun).
data.spec.resourceRef.name string Name of the resource used.
data.spec.resourceRef.namespace string Namespace of the resource.
data.platform boolean Indicates if the job run is platform-based.
data.imported boolean Indicates if the job run was imported.
data.createdBy string User who created the job run.
data.createdAt number Timestamp of when the job run was created.
data.updatedAt number Timestamp of when the job run was updated.
data.status object Status details of the job run.
data.status.ready object Indicates if the job run is ready.
data.status.sync object Indicates synchronization status.
data.status.output object Output details of the job run.
data.status.output.endpoint string Endpoint for the job run output.
data.status.status string Current status of the job run (e.g., Error).

The API response JSON schema is as mentioned below:

{
  "status": {
    "ok": true,
    "msg": "ok"
  },
  "data": {
    "id": "string",
    "name": "string",
    "desc": "string",
    "spec": {
      "templateRef": {
        "kind": "string",
        "name": "string"
      },
      "resourceRef": {
        "kind": "string",
        "name": "string",
        "namespace": "string"
      }
    },
    "platform": false,
    "imported": false,
    "createdBy": "string",
    "createdAt": 0,
    "updatedAt": 0,
    "status": {
      "ready": {},
      "sync": {},
      "output": {
        "endpoint": "string"
      },
      "status": "string"
    }
  }
}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X GET "{{BASE_URL}}/api/v1/projects/:project/publishedresults/:id"
GET {{BASE_URL}}/api/v1/projects/:project/publishedresults/:id HTTP/1.1

Stop Published Result

This API is used to stop a running published job run resource.

Request

  • Method: POST

  • URL: {{BASE_URL}}/api/v1/projects/:project/publishedresults/:id/modify?action=Stop

  • Description: This endpoint is used to stop a running published job run resource.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to stop the job runs.
id path variable This represent s a job run resource id.

Response

  • Status: 200

  • Description: Successfully stopped a running published job run resource.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.

The API response JSON schema as mentioned below:

{    "status": {        "ok": true,        "msg": "ok"    }}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X POST "{{BASE_URL}}/api/v1/projects/:project/publishedresults/:id/modify?action=Stop"
POST {{BASE_URL}}/api/v1/projects/:project/publishedresults/:id/modify?action=Stop HTTP/1.1

Restart Published Result

This API is used to restart a stopped published job run resource.

Request

  • Method: POST

  • URL: {{BASE_URL}}/api/v1/projects/:project/publishedresults/:id/modify?action=Restart

  • Description: This endpoint is used to restart a stopped published job run resource.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to restart the published job run resource.
id path variable This represents a job run resource id.

Response

  • Status: 200

  • Description: Successfully restarted a stopped published job run resource.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.

The API response JSON schema as mentioned below:

{
    "status": {
        "ok": true,
        "msg": "ok"
    }
}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X POST "{{BASE_URL}}/api/v1/projects/:project/publishedresults/:id/modify?action=Restart"
POST {{BASE_URL}}/api/v1/projects/:project/publishedresults/:id/modify?action=Restart HTTP/1.1

Delete Published Result

This API is used to delete a published job run resource based on id.

Request

  • Method: DELETE

  • URL: {{BASE_URL}}/api/v1/projects/:project/publishedresults/:id

  • Description: This endpoint is used to delete a published job run resource based on id.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to delete a published job run resource based on id.
id path variable This represents a published job run resource id.

Response

  • Status: 200

  • Description: Successfully deleted a published job run resource.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.

The API response JSON schema as mentioned below:

{    "status": {        "ok": true,        "msg": "ok"    }}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X DELETE "{{BASE_URL}}/api/v1/projects/:project/publishedresults/:id"
DELETE {{BASE_URL}}/api/v1/projects/:project/publishedresults/:id HTTP/1.1

List Users

This API retrieves a list of users with whom resources can be shared.

Request

  • Method: GET

  • URL: {{BASE_URL}}/api/v1/projects/:id/resourcepermission/users?resourceId=&kind=PublishedResult

  • Description: This endpoint retrieves a list of users with whom resources can be shared.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to retrieve a list of users.
resourceId query Unique identifier for the resource.

Response

  • Status: 200

  • Description: Successfully retrieved list of users.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false)
status.msg string A message providing additional context about the request status
data object Contains the main data returned by the API.
data.id string Unique identifier for the published results.
data.name string Name of the published results.
data.users string List of users with whom resources can be shared.
data.users[].id string Unique identifier for each user.
data.users[].displayName string Display name of the user.
data.users[].email string Email address of the user.
data.users[].allow boolean Indicates if the user is allowed to access the resource.
data.createdAt number Timestamp (in milliseconds) representing when the resource was created.
data.updatedAt number Timestamp (in milliseconds) representing when the resource was last updated.
data.status object Contains the status of the resource.
data.status.ready object Status of the resource’s readiness.
data.status.ready.status string Current readiness status .
data.status.sync object Status of the synchronization process.
data.status.sync.status string Current synchronization status.

The API response JSON schema as mentioned below:

{
    "status": {
        "ok": true,
        "msg": "ok"
    },
    "data": {
        "id": "batchtest",
        "name": "batchtest",
        "createdAt": 1728302283000,
        "updatedAt": 1728302889914,
        "status": {
            "ready": "Unknown",
            "sync": "Pending"
        },
        "users": [
            {
                "id": "user1",
                "email": "user1@example.com",
                "displayName": "user",
                "allow": true
            }
        ]
    }
}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X GET "{{BASE_URL}}/api/v1/projects/:project/resourcepermission/users?resourceId=&kind=PublishedResult"
GET {{BASE_URL}}/api/v1/projects/:project/resourcepermission/users?resourceId=&kind=PublishedResult HTTP/1.1

Share Published Result

This API is used to share a published job run result with other users.

Request

  • Method: PUT

  • URL: {{BASE_URL}}/api/v1/projects/:project/publishedresults/:id/modify?action=Stop

  • Description: This endpoint is used to share a published job run with other users.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to share the published job runs.
id path variable This represents a job run resource id.

Request Body

The API request JSON fields are as mentioned below:

Parameter Type Description
data object Contains the main data of the request.
data.name string The name of the job run.
data.spec object Specification details of the job run.
data.spec.members list List of members with whom resources will be shared.
data.spec.members.memberRef object An object containing member reference.
data.spec.members.memberRef.name string This represents the member name.
data.spec.resource object An object containing resource specification.
data.spec.resource.kind string This represents the resource kind.
data.spec.resource.name string This represents the resource name.

The API request JSON schema is as mentioned below:

{
    "data": {
        "name": "batchtest",
        "spec": {
            "members": [
                {
                    "memberRef": {
                        "name": "user2"
                    }
                }
            ],
            "resource": {
                "kind": "PublishedResult",
                "name": "batchtest"
            }
        }
    }
}

Response

  • Status: 200

  • Description: Successfully shared a published job run.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.

The API response JSON schema as mentioned below:

{
    "status": {
        "ok": true,
        "msg": "ok"
    }
}

Request Headers

  • content-type: application/json

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X PUT -H "content-type: application/json" -d '{
    "data": {
        "name": "batchtest",
        "spec": {
            "members": [
                {
                    "memberRef": {
                        "name": "user2"
                    }
                }
            ],
            "resource": {
                "kind": "PublishedResult",
                "name": "batchtest"
            }
        }
    }
}' "{{BASE_URL}}/api/v1/projects/:project/resourcepermissions/:id"
PUT {{BASE_URL}}/api/v1/projects/:project/resourcepermissions/:id HTTP/1.1
content-type: application/json, text/plain, */*

{
    "data": {
        "name": "batchtest",
        "spec": {
            "members": [
                {
                    "memberRef": {
                        "name": "user2"
                    }
                }
            ],
            "resource": {
                "kind": "PublishedResult",
                "name": "batchtest"
            }
        }
    }
}

Workspaces

Create Workspace

This API is used to create a workspace within a specific project.

Request

  • Method: POST

  • URL: {{BASE_URL}}/api/v1/projects/:project/workspaces

  • Description: This endpoint is used to create workspace within a specific project.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to create a workspace.

Request Body

The API request JSON fields are as mentioned below:

Parameter Type Description
data object An object containing request info for creating a workspace.
data.name string User-defined name for workspace.
data.desc string User-defined value of description, providing additional context.
data.spec object Specification of the workspace resource, detailing its configuration and references.
data.spec.templateRef object Reference to the template used for the workspace creation.
data.spec.templateRef.kind string The kind of the template.
data.spec.templateRef.name string The name of the template being referenced.
data.spec.capacity object Resource capacity specifications.
data.spec.capacity.CPU string Amount of CPU requested.
data.spec.capacity.memory string Amount of memory requested.
data.spec.capacity.gpu string Amount of GPU requested.
data.spec.type string Type of the workspace.

The API request JSON schema is mentioned below:

{
    "data": {
        "spec": {
            "capacity": {
                "cpu": "",
                "memory": "",
                "gpu": ""
            },
            "templateRef": {
                "apiVersion": "",
                "kind": "",
                "name": ""
            },
            "type": ""
        },
        "name": "",
        "desc": ""
    }
}

Response

  • Status: 200

  • Description: Successfully created a workspace.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false)
status.msg string A message providing additional context about the request status

The API response JSON schema as mentioned below:

{    "status": {        "ok": true,        "msg": "ok"    }}

Request Headers

  • content-type: application/json

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X POST -H "content-type: application/json" -d '{
    "data": {
        "spec": {
            "capacity": {
                "cpu": "1",
                "memory": "1Gi",
                "gpu": ""
            },
            "templateRef": {
                "apiVersion": "",
                "kind": "GlobalWorkspaceTemplate",
                "name": "proteinfolding-alphafold2-jupyter-v1"
            },
            "type": "Notebook"
        },
        "name": "Test Demo 1",
        "desc": ""
    }
}' "{{BASE_URL}}/api/v1/projects/:project/workspaces"
POST {{BASE_URL}}/api/v1/projects/:project/workspaces HTTP/1.1
content-type:  application/json

{
    "data": {
        "spec": {
            "capacity": {
                "cpu": "1",
                "memory": "1Gi",
                "gpu": ""
            },
            "templateRef": {
                "apiVersion": "",
                "kind": "GlobalWorkspaceTemplate",
                "name": "proteinfolding-alphafold2-jupyter-v1"
            },
            "type": "Notebook"
        },
        "name": "Test Demo 1",
        "desc": ""
    }
}

List Workspaces

The API fetches and returns a list of all workspaces resources.

Request

  • Method: GET

  • URL: {{BASE_URL}}/api/v1/projects/:project/workspaces

  • Description: This endpoint fetches and returns a list of all workspaces resources.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

This API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to retrieve the list of workspaces resources.

Response

  • Status: 200

  • Description: Successfully retrieved list of workspaces resources.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.
data object An object containing workspaces resources.
data.items list List of workspace resource items.
data.items[].id string Unique identifier for the resources.
data.items[].namespace string namespace of the resources.
data.items[].name string name of the resources.
data.items[].spec object Specification details of the resources.
data.items[].spec.templateRef object Reference to the template used.
data.items[].spec.templateRef.kind string Kind of the template.
data.items[].spec.templateRef.name string Name of the template used.
data.items[].spec.capacity object Resource capacity specifications.
data.items[].spec.capacity.cpu string Amount of CPU requested.
data.items[].spec.capacity.memory string Amount of memory requested.
data.items[].spec.capacity.gpu string Amount of GPU requested.
data.items[].spec.type string Type of the workspace resource.
data.items[].platform boolean Indicates if the resource is platform-based.
data.items[].imported boolean Indicates if the resource was imported.
data.items[].createdBy string User who created the resource.
data.items[].createdAt number Timestamp of when the resource was created.
data.items[].updatedAt number Timestamp of when the resource was updated.
data.items[].status object Status details of the resource.
data.items[].status.ready object Indicates if the resource is ready.
data.items[].status.sync object Indicates synchronisation status.
data.items[].status.output object Output details of the resource.
data.items[].status.output.artifactURI string ArtifactURI for the resource output.
data.items[].status.output.endpoint string Endpoint for the resource output.
data.items[].status.status string Current status of the resource (e.g., Error).

The API response JSON schema is as mentioned below:

{
    "status": {
        "ok": true,
        "msg": "ok"
    },
    "data": {
        "items": [
            {
                "id": "testbactmap",
                "namespace": "user1",
                "name": "TestBactMap",
                "spec": {
                    "templateRef": {
                        "kind": "GlobalWorkspaceTemplate",
                        "name": "jupyter-base-mldemo-v1"
                    },
                    "capacity": {
                        "cpu": "1",
                        "memory": "1Gi"
                    },
                    "type": "Notebook"
                },
                "platform": false,
                "imported": false,
                "createdBy": "user1",
                "createdAt": 1728315328000,
                "updatedAt": 1728315328024,
                "status": {
                    "ready": {},
                    "sync": {},
                    "output": {
                        "artifactURI": "",
                        "endpoint": ""
                    },
                    "status": "Error"
                }
            }
        ]
    }
}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X GET "{{BASE_URL}}/api/v1/projects/:project/workspaces"
GET {{BASE_URL}}/api/v1/projects/:project/workspaces HTTP/1.1

Get Workspace

The API fetches and returns a workspace resource based on the id.

Request

  • Method: GET

  • URL: {{BASE_URL}}/api/v1/projects/:project/workspaces

  • Description: This endpoint fetches and returns a workspace resource based on the requested Id.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

This API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to retrieve the workspace resource.
id path variable This represents a workspace resource id.

Response

  • Status: 200

  • Description: Successfully retrieved specific workspace resource.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.
data object An object containing workspace resources.
data.id string Unique identifier for the resources.
data.name string name of the resources.
data.spec object Specification details of the resources.
data.spec.templateRef object Reference to the template used.
data.spec.templateRef.kind string Kind of the template.
data.spec.templateRef.name string Name of the template used.
data.spec.capacity object Resource capacity specifications.
data.spec.capacity.cpu string Amount of CPU requested.
data.spec.capacity.memory string Amount of memory requested.
data.spec.capacity.gpu string Amount of GPU requested.
data.spec.type string Type of the workspace resource.
data.platform boolean Indicates if the resource is platform-based.
data.imported boolean Indicates if the resource was imported.
data.createdBy string User who created the resource.
data..createdAt number Timestamp of when the resource was created.
data.updatedAt number Timestamp of when the resource was updated.
data.status object Status details of the resource.
data.status.ready object Indicates if the resource is ready.
data..status.sync object Indicates synchronization status.
data.status.output object Output details of the resource.
data.status.output.artifactURI string ArtifactURI for the resource output.
data.status.output.endpoint string Endpoint for the resource output.
data.status.status string Current status of the resource (e.g., Error).

The API response JSON schema is as mentioned below:

{
    "status": {
        "ok": true,
        "msg": "ok"
    },
    "data": {
        "id": "testbactmap",
        "name": "TestBactMap",
        "spec": {
            "templateRef": {
                "kind": "GlobalWorkspaceTemplate",
                "name": "jupyter-base-mldemo-v1"
            },
            "capacity": {
                "cpu": "1",
                "memory": "1Gi"
            },
            "type": "Notebook"
        },
        "platform": false,
        "imported": false,
        "createdBy": "user1",
        "createdAt": 1728315328000,
        "updatedAt": 1728315328024,
        "status": {
            "ready": {},
            "sync": {},
            "output": {
                "artifactURI": "",
                "endpoint": ""
            },
            "status": "Error"
        }
    }
}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X GET "{{BASE_URL}}/api/v1/projects/:project/workspaces/:id"
GET {{BASE_URL}}/api/v1/projects/:project/workspaces/:id HTTP/1.1

Delete Workspace

This API is used to delete a workspace.

Request

  • Method: DELETE

  • URL: {{BASE_URL}}/api/v1/projects/:project/workspace/:id

  • Description: This endpoint is used to delete a workspace.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to delete the workspace.
id path variable This represents a workspace id.

Response

  • Status: 200

  • Description: Successfully deleted a workspace.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.

The API response JSON schema as mentioned below:

{    "status": {        "ok": true,        "msg": "ok"    }}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X DELETE "{{BASE_URL}}/api/v1/projects/:project/workspaces/:id"
DELETE {{BASE_URL}}/api/v1/projects/:project/workspaces/:id HTTP/1.1

Start Workspace

This API is used to start running a workspace.

Request

  • Method: POST

  • URL: {{BASE_URL}}/api/v1/projects/:project/workspaces/:id/modify?action=Start&scope=

  • Description: This endpoint is used to start running a workspace.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to start the workspace resource.
id path variable This represents a workspace id.
scope query This represents the user’s namespace.

Response

  • Status: 200

  • Description: Successfully started a workspace.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.

The API response JSON schema as mentioned below:

{    "status": {        "ok": true,        "msg": "ok"    }}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X POST "{{BASE_URL}}/api/v1/projects/:project/workspaces/:id/modify?action=Start&scope="
POST {{BASE_URL}}/api/v1/projects/:project/workspaces/:id/modify?action=Start&scope= HTTP/1.1

Stop Workspace

This API is used to stop a running workspace.

Request

  • Method: POST

  • URL: {{BASE_URL}}/api/v1/projects/:project/workspaces/:id/modify?action=Restart&scope=

  • Description: This endpoint is used to stop a running workspace.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to stop the workspace.
id path variable This represents a workspace id.
scope query This represents the user’s namespace.

Response

  • Status: 200

  • Description: Successfully stopped a running workspace.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.

The API response JSON schema as mentioned below:

{    "status": {        "ok": true,        "msg": "ok"    }}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X POST "{{BASE_URL}}/api/v1/projects/:project/workspaces/:id/modify?action=Stop&scope="
POST {{BASE_URL}}/api/v1/projects/:project/workspaces/:id/modify?action=Stop&scope= HTTP/1.1

Restart Workspace

This API is used to restart a stopped workspace.

Request

  • Method: POST

  • URL: {{BASE_URL}}/api/v1/projects/:project/workspaces/:id/modify?action=Restart&scope=

  • Description: This endpoint is used to restart a stopped workspace.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to restart the workspace.
id path variable This represents a workspace id.
scope query This represents the user’s namespace.

Response

  • Status: 200

  • Description: Successfully restarted a stopped workspace.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.

The API response JSON schema as mentioned below:

{    "status": {        "ok": true,        "msg": "ok"    }}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X POST "{{BASE_URL}}/api/v1/projects/:project/workspaces/:id/modify?action=Restart&scope="
POST {{BASE_URL}}/api/v1/projects/:project/workspaces/:id/modify?action=Restart&scope= HTTP/1.1

Download Workspace Result

This API is used to download workspace result.

Request

  • Method: POST

  • URL: {{BASE_URL}}/api/v1/projects/:project/settings/inputs/downloadurl?path=&kind=workspace&id=

  • Description: This endpoint is used to download workspace result.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which for to download workspace result.
id query This represents a workspace id.
path query This represents the file path.

Response

  • Status: 200

  • Description: Successfully downloaded workspace result.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.
data object Contains the main data returned by the API.
data.url string Contains url to download the result.

The API response JSON schema as mentioned below:

{
    "status": {
        "ok": true,
        "msg": "ok"
    },
    "data": {
        "url": "<url for downloading result>"
    }
}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X POST "{{BASE_URL}}/api/v1/projects/:project/settings/inputs/downloadurl?path=&kind=workspace&id="
POST {{BASE_URL}}/api/v1/projects/:project/settings/inputs/downloadurl?path=&kind=workspace&id= HTTP/1.1

List Users

This API retrieves a list of users with whom workspace can be shared.

Request

  • Method: GET

  • URL: {{BASE_URL}}/api/v1/projects/:project/resourcepermission/users?resourceId=&kind=Workspace

  • Description: This endpoint retrieves a list of users with whom resources can be shared.

  • Parameters:

    • BASE_URL: The base URL of the request.

    • project: The specific project identifier for which to retrieve list users.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to retrieve list users.
resourceId query Unique identifier for the resource.
kind query Kind of resource. Default value is Workspace.

Response

  • Status: 200

  • Description: Successfully retrieved list of users.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false)
status.msg string A message providing additional context about the request status
data object Contains the main data returned by the API.
data.id string Unique identifier for the published results.
data.name string Name of the published results.
data.users string List of users with whom resources can be shared.
data.users[].id string Unique identifier for each user.
data.users[].displayName string Display name of the user.
data.users[].email string Email address of the user.
data.users[].allow boolean Indicates if the user is allowed to access the resource.
data.createdAt number Timestamp (in milliseconds) representing when the resource was created.
data.updatedAt number Timestamp (in milliseconds) representing when the resource was last updated.
data.status object Contains the status of the resource.
data.status.ready object Status of the resource’s readiness.
data.status.ready.status string Current readiness status .
data.status.sync object Status of the synchronization process.
data.status.sync.status string Current synchronization status.

The API response JSON schema as mentioned below:

{
    "status": {
        "ok": true,
        "msg": "ok"
    },
    "data": {
        "id": "batchtest",
        "name": "batchtest",
        "createdAt": 1728302283000,
        "updatedAt": 1728302889914,
        "status": {
            "ready": "Unknown",
            "sync": "Pending"
        },
        "users": [
            {
                "id": "user1",
                "email": "user1@example.com",
                "displayName": "user",
                "allow": true
            }
        ]
    }
}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X GET "{{BASE_URL}}/api/v1/projects/:project/resourcepermission/users?resourceId=&kind=Workspace"
GET {{BASE_URL}}/api/v1/projects/:project/resourcepermission/users?resourceId=&kind=Workspace HTTP/1.1

Share Workspace

This API is used to share a workspace with other users.

Request

  • Method: PUT

  • URL: {{BASE_URL}}/api/v1/projects/:project/resourcepermissions/:id

  • Description: This endpoint is used to share a workspace resource with other users.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameter fields are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to share the workspace.
id path variable This represents a workspace id.

Request Body

The API request JSON fields are as mentioned below:

Parameter Type Description
data object Contains the main data of the request.
data.name string The name of the workspace.
data.spec object Specification details of the workspace.
data.spec.members list List of members with whom resources will be shared.
data.spec.members.memberRef object An object containing member reference.
data.spec.members.memberRef.name string This represents the member name.
data.spec.resource object An object containing resource specification.
data.spec.resource.kind string This represents resource kind.
data.spec.resource.name string This represents the resource name.

The API request JSON schema is as mentioned below:

{
    "data": {
        "name": "testbactmap",
        "spec": {
            "members": [
                {
                    "memberRef": {
                        "name": "user3"
                    }
                }
            ],
            "resource": {
                "kind": "Workspace",
                "name": "testbactmap"
            }
        }
    }
}

Response

  • Status: 200

  • Description: Successfully shared a published a workspace.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.

The API response JSON schema as mentioned below:

{
    "status": {
        "ok": true,
        "msg": "ok"
    }
}

Request Headers

  • content-type: application/json

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X PUT -H "content-type: application/json" -d '{
    "data": {
        "name": "testbactmap",
        "spec": {
            "members": [
                {
                    "memberRef": {
                        "name": "user3"
                    }
                }
            ],
            "resource": {
                "kind": "Workspace",
                "name": "testbactmap"
            }
        }
    }
}' "{{BASE_URL}}/api/v1/projects/:project/resourcepermissions/:id"
PUT {{BASE_URL}}/api/v1/projects/:project/resourcepermissions/:id HTTP/1.1
{
    "data": {
        "name": "testbactmap",
        "spec": {
            "members": [
                {
                    "memberRef": {
                        "name": "user3"
                    }
                }
            ],
            "resource": {
                "kind": "Workspace",
                "name": "testbactmap"
            }
        }
    }
}

List Workspace Templates

This API is used to retrieve a list of workspace templates within a specific project.

Request

  • Method: GET

  • URL: {{BASE_URL}}/api/v1/projects/:project/workspacetemplates

  • Description: This endpoint is used to retrieve a list of workspace templates within a specific project.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

This API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to retrieve a list of workspace templates.

Response

  • Status: 200

  • Description: Successfully retrieved list of workspace templates.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false)
status.msg string A message providing additional context about the request status
data object An object containing response data items.
data.items list List of items in the response.
data.items[].id string Unique identifier for the item.
data.items[].name string Name of the item.
data.items[].spec object Specifications for the item.
data.items[].spec.image object Image specifications.
data.items[].spec.image.uri string URI of the image.
data.items[].spec.image.imageRef object Reference for the image.
data.items[].spec.image.imageRef.name string Name of the image reference
data.items[].spec.image.profileRef Object Reference for the image profile.
data.items[].spec.image.profileRef.name string Name of the image profile.
data.items[].spec.type string Type of the workspace template.
data.items[].spec.capacity object Resource capacity specifications.
data.items[].spec.capacity.cpu string Amount of CPU requested.
data.items[].spec.capacity.memory string Amount of memory requested.
data.items[].spec.capacity.gpu string Amount of GPU requested.
data.items[].spec.rbac object RBAC settings for the resource.
data.items[].spec.rbac.enabled boolean indicates if RBAC is enabled or not.
data.items[].spec.rbac.rules list List of RBAC rules.
data.items[].spec.display object Indicates resource display specification.
data.items[].spec.display.name string Indicates resource display name.
data.items[].spec.display.desc string Indicates resource display description.
data.items[].spec.display.icon string Indicates resource display icon.
data.items[].spec.display.tags list List of resource associated tags.
data.items[].spec.display.labels list List of resource associated labels.
data.items[].spec.display.props object Additional properties for display.
data.items[].spec.launchConfigSelector object Selector for launch configuration.
data.items[].spec.launchConfigSelector.ref object Reference for the launch configuration.
data.items[].spec.launchConfigSelector.ref.name string Name of the launch configuration reference.
data.items[].platform string Indicates if the resource is platform-based.
data.items[].imported string Indicates if the resource was imported.
data.items[].ref object Reference for the resource.
data.items[].ref.apiVersion string API version of the resource.
data.items[].ref.kind string Kind of the resource.
data.items[].ref.name string Name of the resource.
data.items[].createdAt number Timestamp of when the resource was created.
data.items[].updatedAt number Timestamp of when the resource was updated.
data.items[].status object Status details of the resource.
data.items[].status.ready object Indicates if the resource is ready.
data.items[].status.ready.status string Status of readiness.
data.items[].status.sync object Indicates if the resource is synced.
data.items[].status.sync.status string Status of sync.

The API response JSON schema as mentioned below:

{
    "status": {
        "ok": true,
        "msg": "ok"
    },
    "data": {
        "items": [
            {
                "id": "",
                "name": "",
                "spec": {
                    "image": {
                        "imageRef": {
                            "name": ""
                        },
                        "profileRef": {
                            "name": ""
                        }
                    },
                    "type": "",
                    "capacity": {
                        "cpu": "",
                        "memory": ""
                    },
                    "rbac": {
                        "enabled": false,
                        "rules": null
                    },
                    "display": {
                        "name": "",
                        "desc": "",
                        "icon": "",
                        "tags": [
                            {
                                "name": "",
                                "value": ""
                            }
                        ],
                        "labels": [
                            {
                                "name": "",
                                "value": ""
                            },
                            {
                                "name": "",
                                "value": ""
                            },
                            {
                                "name": "",
                                "value": ""
                            }
                        ],
                        "props": {
                            "dev.badges": ""
                        }
                    },
                    "launchConfigSelector": {
                        "ref": {
                            "name": ""
                        }
                    }
                },
                "platform": false,
                "imported": false,
                "ref": {
                    "apiVersion": "",
                    "kind": "",
                    "name": ""
                },
                "createdAt": 1709907223000,
                "updatedAt": 1709907223000,
                "status": {
                    "ready": {
                        "status": ""
                    },
                    "sync": {
                        "status": ""
                    }
                }
            }
        ]
    }
}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X GET "{{BASE_URL}}/api/v1/projects/:project/workspacetemplates"
GET {{BASE_URL}}/api/v1/projects/:project/workspacetemplates HTTP/1.1

Get Workspace Template

This API is used to retrieve a specific workspace template within a specific project.

Request

  • Method: GET

  • URL: {{BASE_URL}}/api/v1/projects/:project/workspacetemplates/:id

  • Description: This endpoint is used to retrieve a specific workspace template within a specific project.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to retrieve a workspace template.
id path variable This represents a unique indentifier for workspace templates.

Response

  • Status: 200

  • Description: Successfully retrieved a workspace template.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false)
status.msg string A message providing additional context about the request status
data object An object containing response data.
data.id string Unique identifier for the item.
data.name string Name of the item.
data.spec object Specifications for the item.
data.spec.image object Image specifications.
data.spec.image.uri string URI of the image.
data.spec.image.imageRef object Reference for the image.
data.spec.image.imageRef.name string Name of the image reference
data.spec.image.profileRef Object Reference for the image profile.
data.spec.image.profileRef.name string Name of the image profile.
data.spec.type string Type of the workspace template.
data.spec.capacity object Resource capacity specifications.
data.spec.capacity.cpu string Amount of CPU requested.
data.spec.capacity.memory string Amount of memory requested.
data.spec.capacity.gpu string Amount of GPU requested.
data.spec.rbac object RBAC settings for the resource.
data.spec.rbac.enabled boolean indicates if RBAC is enabled or not.
data.spec.rbac.rules list List of RBAC rules.
data.spec.display object Indicates resource display specification.
data.spec.display.name string Indicates resource display name.
data.spec.display.desc string Indicates resource display description.
data.spec.display.icon string Indicates resource display icon.
data.spec.display.tags list List of resource associated tags.
data.spec.display.labels list List of resource associated labels.
data.spec.display.props object Additional properties for display.
data.spec.launchConfigSelector object Selector for launch configuration.
data.spec.launchConfigSelector.ref object Reference for the launch configuration.
data.spec.launchConfigSelector.ref.name string Name of the launch configuration reference.
data.platform string Indicates if the resource is platform-based.
data.imported string Indicates if the resource was imported.
data.ref object Reference for the resource.
data.ref.apiVersion string API version of the resource.
data.ref.kind string Kind of the resource.
data.ref.name string Name of the resource.
data.createdAt number Timestamp of when the resource was created.
data.updatedAt number Timestamp of when the resource was updated.
data.status object Status details of the resource.
data.status.ready object Indicates if the resource is ready.
data.status.ready.status string Status of readiness.
data.status.sync object Indicates if the resource is synced.
data.status.sync.status string Status of sync.

The API response JSON schema as mentioned below:

{
    "status": {
        "ok": true,
        "msg": "ok"
    },
    "data": {
        "items": [
            {
                "id": "",
                "name": "",
                "spec": {
                    "image": {
                        "imageRef": {
                            "name": ""
                        },
                        "profileRef": {
                            "name": ""
                        }
                    },
                    "type": "",
                    "capacity": {
                        "cpu": "",
                        "memory": ""
                    },
                    "rbac": {
                        "enabled": false,
                        "rules": null
                    },
                    "display": {
                        "name": "",
                        "desc": "",
                        "icon": "",
                        "tags": [
                            {
                                "name": "",
                                "value": ""
                            }
                        ],
                        "labels": [
                            {
                                "name": "",
                                "value": ""
                            },
                            {
                                "name": "",
                                "value": ""
                            },
                            {
                                "name": "",
                                "value": ""
                            }
                        ],
                        "props": {
                            "dev.badges": ""
                        }
                    },
                    "launchConfigSelector": {
                        "ref": {
                            "name": ""
                        }
                    }
                },
                "platform": false,
                "imported": false,
                "ref": {
                    "apiVersion": "",
                    "kind": "",
                    "name": ""
                },
                "createdAt": 1709907223000,
                "updatedAt": 1709907223000,
                "status": {
                    "ready": {
                        "status": ""
                    },
                    "sync": {
                        "status": ""
                    }
                }
            }
        ]
    }
}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X GET "{{BASE_URL}}/api/v1/projects/:project/workspacetemplates/:id"
GET {{BASE_URL}}/api/v1/projects/:project/workspacetemplates/:id HTTP/1.1

Apps

List Apps

The API fetches and returns a list of all apps.

Request

  • Method: GET

  • URL: {{BASE_URL}}/api/v1/projects/:project/scitools

  • Description: This endpoint fetches and returns a list of all apps.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to retrieve the list of all apps.

Response

  • Status: 200

  • Description: Successfully retrieved list of all apps.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.
data object An object containing app resources.
data.items list List of app resource items.
data.items[].id string Unique identifier for the app resources.
data.items[].name string name of the resources.
data.items[].spec object Specification details of the resources.
data.items[].spec.capacity object Resource capacity specifications.
data.items[].spec.capacity.cpu string Amount of CPU requested.
data.items[].spec.capacity.memory string Amount of memory requested.
data.items[].spec.capacity.gpu string Amount of GPU requested.
data.items[].spec.templateSpec object Specification of the template for the app resource.
data.items[].spec.templateSpec.image object Details of the image used for the app resource.
data.items[].spec.templateSpec.image.uri string URI of the image used for the app.
data.items[].spec.templateSpec.image.port number Port number for the image.
data.items[].spec.templateSpec.image.env object Env object for the image.
data.items[].spec.templateSpec.image.capacity object Capacity requirements for the image.
data.items[].spec.templateSpec.image.capacity.cpu string CPU capacity for the image.
data.items[].spec.templateSpec.image.capacity.memory string Memory capacity for the image.
data.items[].spec.templateSpec.image.imageRef object Reference for the image.
data.items[].spec.templateSpec.image.imageRef.name string Name of the image reference
data.items[].spec.templateSpec.image.profileRef object Reference for the image profile.
data.items[].spec.templateSpec.image.profileRef.name string Name of the image profile.
data.items[].spec.templateSpec.rbac object RBAC settings for the resource.
data.items[].spec.templateSpec.rbac.enabled boolean Indicates if RBAC is enabled or not.
data.items[].spec.templateSpec.rbac.rules object List of RBAC rules.
data.items[].spec.templateSpec.route object Routing configuration for the app resource.
data.items[].spec.templateSpec.route.rewrite string Defines the rewrite rule for the route.
data.items[].spec.templateSpec.launchConfigSelector object Selector for launch configuration.
data.items[].spec.templateSpec.launchConfigSelector.ref object Reference for the launch configuration.
data.items[].spec.templateSpec.launchConfigSelector.ref.name name Name of the launch configuration reference.
data.items[].spec.templateSpec.accessPolicies list Define the permissions and access controls for app resources.
data.items[].spec.templateSpec.apps object An object containing application details associated with the resource.
data.items[].createdBy string User who created the resource.
data.items[].createdAt number Timestamp of when the resource was created.
data.items[].updatedAt number Timestamp of when the resource was updated.
data.items[].status object Status details of the resource.
data.items[].status.ready object Indicates if the resource is ready.
data.items[].status.sync object Indicates synchronization status.
data.items[].status.output object Output details of the resource.
data.items[].status.output.apps list List of apps for the resource output.
data.items[].status.output.endpoint string Endpoint for the resource output.
data.items[].status.status string Current status of the resource (e.g., Error).

The API response JSON schema is as mentioned below:

{
    "status": {
        "ok": true,
        "msg": "ok"
    },
    "data": {
        "items": [
            {
                "id": "testbactmap",
                "namespace": "user1",
                "name": "TestBactMap",
                "spec": {
                    "templateRef": {
                        "kind": "GlobalWorkspaceTemplate",
                        "name": "jupyter-base-mldemo-v1"
                    },
                    "capacity": {
                        "cpu": "1",
                        "memory": "1Gi"
                    },
                    "type": "Notebook"
                },
                "platform": false,
                "imported": false,
                "createdBy": "user1",
                "createdAt": 1728315328000,
                "updatedAt": 1728315328024,
                "status": {
                    "ready": {},
                    "sync": {},
                    "output": {
                        "artifactURI": "",
                        "endpoint": ""
                    },
                    "status": "Error"
                }
            }
        ]
    }
}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X GET "{{BASE_URL}}/api/v1/projects/:project/scitools"
GET %{{BASE_URL}}/api/v1/projects/:project/scitools HTTP/1.1

Start App

This API is used to start an app.

Request

  • Method: POST

  • URL: {{BASE_URL}}/api/v1/projects/:project/scitools/:id/modify?action=Start

  • Description: This endpoint is used to start an app.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to start an apps.
id path variable This represents app resource id.

Response

  • Status: 200

  • Description: Successfully started an app.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.

The API response JSON schema as mentioned below:

{    "status": {        "ok": true,        "msg": "ok"    }}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X POST "{{BASE_URL}}/api/v1/projects/:project/scitools/:id/modify?action=Start"
POST {{BASE_URL}}/api/v1/projects/:project/scitools/:id/modify?action=Start HTTP/1.1

Restart App

This API is used to restart an app.

Request

  • Method: POST

  • URL: {{BASE_URL}}/api/v1/projects/:project/scitools/:id/modify?action=Restart

  • Description: This endpoint is used to restart an app.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to restart an app.
id path variable This represents an app id.

Response

  • Status: 200

  • Description: Successfully restarted an app.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.

The API response JSON schema as mentioned below:

{    "status": {        "ok": true,        "msg": "ok"    }}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X POST "{{BASE_URL}}/api/v1/projects/:project/scitools/:id/modify?action=Restart"
POST {{BASE_URL}}/api/v1/projects/:project/scitools/:id/modify?action=Restart HTTP/1.1

Stop App

This API is used to stop an app.

Request

  • Method: POST

  • URL: {{BASE_URL}}/datascience/api/v1/projects/:project/scitools/:id/modify?action=Stop

  • Description: This endpoint is used to stop an app.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as mentioned below:

Parameter Type Description
project path variable The specific project identifier for which to stop an app.
id path variable This represents an app id.

Response

  • Status: 200

  • Description: Successfully stopped an app.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.

The API response JSON schema as mentioned below:

{    "status": {        "ok": true,        "msg": "ok"    }}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X POST "{{BASE_URL}}/api/v1/projects/:project/scitools/:id/modify?action=Stop"
POST {{BASE_URL}}api/v1/projects/:project/scitools/:id/modify?action=Stop HTTP/1.1

Delete App

This API is used to delete an app.

Request

  • Method: DELETE

  • URL: {{BASE_URL}}/api/v1/projects/:project/scitools/:id

  • Description: This endpoint is to delete an app.

  • Parameters:

    • BASE_URL: The base URL of the request.

Request Parameters

The API request parameters are as defined below:

Parameter Type Description
project path variable The specific project identifier for which to delete an app.
id path variable This represents an app id.

Response

  • Status: 200

  • Description: Successfully deleted an app.

Response Body

The API response will be a JSON object with the following fields:

Parameter Type Description
status object An object that represents the overall response status of the request.
status.ok boolean A boolean value indicating whether the request was successful (true) or not (false).
status.msg string A message providing additional context about the request status.

The API response JSON schema as mentioned below:

{    "status": {        "ok": true,        "msg": "ok"    }}

Response Headers

  • content-type: application/json

  • x-request-id: a182274c-8ef8-45ce-830a-edd005cc89c0

curl -X DELETE "{{BASE_URL}}/api/v1/projects/:project/scitools/:id"
DELETE {{BASE_URL}}/api/v1/projects/:project/scitools/:id HTTP/1.1