REST API Resources

Use this page as a resource for discovering DataOps.live resources you can access via the DataOps.live API.

Learn more about getting started with the API on the Using the REST API page.

Project pipelines

Schedule a pipeline

Authentication

Authenticate via an "access token". For detailed steps on getting an access token, refer to Using the REST API - Access tokens.

URL endpoint

https://app.dataops.live/api/v4/projects/:project_id/pipeline_schedules

Required parameters

Parameter	Type	Required	Description
id	Integer/String	Yes	ID or URL-encoded path of the project owned by the authenticated user
description	String	Yes	Description of the pipeline schedule
ref	String	Yes	Branch or tag name that is triggered
cron	String	Yes	Cron schedule, for example: 01 * * *
cron_timezone	String	No	Time zone supported by ActiveSupport::TimeZone, for example: Pacific Time (US & Canada), (default: UTC)
active	Boolean	No	Activation of pipeline schedule. If set to FALSE, the pipeline schedule is deactivated (default: TRUE)

Example curl request (replace the parameters with your values):

curl --request POST \
     --header "PRIVATE-TOKEN: <TOKEN>" \
     --form description="Build packages" \
     --form ref="master" \
     --form cron="0 1 * * 5" \
     --form cron_timezone="UTC" \
     --form active="true" \
     "https://app.dataops.live/api/v4/projects/:project_id/pipeline_schedules"

Trigger a pipeline

Authentication

Authenticate via a "pipeline trigger token". For detailed steps on getting a pipeline trigger token, refer to Running pipelines - Pipeline trigger.

URL endpoint

https://app.dataops.live/api/v4/projects/$PROJECT_ID/trigger/pipeline

Required parameters

Parameter	Description	Examples
Project ID	Project ID from the project overview page under the project title (used in the URL)	830, 49187
Trigger token	Pipeline trigger token from project Settings → CI/CD → Pipeline triggers	a9b6737105a4a54...
Git ref (a commit, branch name or commit tag)	Specific reference to the git history for what pipeline to trigger	b489ddde, my-feature-branch, v1-dev-tag
Pipeline configuration file path	Path including the file name of the pipeline file you want to trigger, provided to the request as pipeline variable	full-ci.yml, new-ci.yml, other-pipelines/pipe1-ci.yml

Example curl request (replace the four parameters with your values):

curl --request POST \
     --header "PRIVATE-TOKEN: <TOKEN>" \
     --form description="Build packages" \
     --form ref="master" \
     --form cron="0 1 * * 5" \
     --form cron_timezone="UTC" \
     --form active="true" \
     "https://app.dataops.live/api/v4/projects/:project_id/pipeline_schedules"

Get pipelines

Authentication

Authenticate via an "access token". For detailed steps on getting an access token, refer to Using the REST API - Access tokens.

URL endpoint

https://app.dataops.live/api/v4/projects/$PROJECT_ID/pipelines

Required parameters

Parameter	Description	Examples
Project ID	Project ID from the project overview page under the project title (used in the URL)	830, 49187

Example curl request (replace the parameter with your value):

curl --request GET \
     --header "private-token: ACCESS_TOKEN" \
     "https://app.dataops.live/api/v4/projects/PROJECT_ID/pipelines"

Get pipeline detail

Authentication

Authenticate via an "access token". For detailed steps on getting an access token, refer to Using the REST API - Access tokens.

URL endpoint

https://app.dataops.live/api/v4/projects/$PROJECT_ID/pipelines/$PIPELINE_ID

Required parameters

Parameter	Description	Examples
Project ID	Project ID from the project overview page under the project title (used in the URL)	830, 49187
Pipeline ID	Pipeline ID from the available list of pipelines (used in the URL)	1451, 74773

Example curl request (replace the parameter with your value):

curl --request GET \
     --header "private-token: ACCESS_TOKEN" \
     "https://app.dataops.live/api/v4/projects/PROJECT_ID/pipelines/PIPELINE_ID"

Get jobs

Authentication

Authenticate via an "access token". For detailed steps on getting an access token, refer to Using the REST API - Access tokens.

URL endpoint

https://app.dataops.live/api/v4/projects/$PROJECT_ID/jobs

Required parameters

Parameter	Description	Examples
Project ID	Project ID from the project overview page under the project title (used in the URL)	830, 49187

Example curl request (replace the parameter with your value):

curl --request GET \
     --header "private-token: ACCESS_TOKEN" \
     "https://app.dataops.live/api/v4/projects/PROJECT_ID/jobs"

Get job detail

Authentication

Authenticate via an "access token". For detailed steps on getting an access token, refer to Using the REST API - Access tokens.

URL endpoint

https://app.dataops.live/api/v4/projects/$PROJECT_ID/jobs/$JOB_ID

Required parameters

Parameter	Description	Examples
Project ID	Project ID from the project overview page under the project title (used in the URL)	830, 49187
Job ID	Job ID from the available list of jobs (used in the URL)	47217, 4325421

Example curl request (replace the parameter with your value):

curl --request GET \
     --header "private-token: ACCESS_TOKEN" \
     "https://app.dataops.live/api/v4/projects/PROJECT_ID/jobs/JOB_ID"

Get job logs

Authentication

Authenticate via an "access token". For detailed steps on getting an access token, please refer to Using the REST API - Access tokens.

URL endpoint

https://app.dataops.live/api/v4/projects/$PROJECT_ID/jobs/$JOB_ID/trace

Required parameters

Parameter	Description	Examples
Project ID	Project ID from the project overview page under the project title (used in the URL)	830, 49187
Job ID	Job ID from the available list of jobs (used in the URL)	47217, 4325421

Example curl request (replace the parameter with your value):

curl --request GET \
     --header "private-token: ACCESS_TOKEN" \
     "https://app.dataops.live/api/v4/projects/PROJECT_ID/jobs/JOB_ID/trace"

Supported API resources

The API of the DataOps.live Platform is almost identical to the GitLab REST API and can integrate with many external applications. See Develop with GitLab for a detailed resources list.