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
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
http://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 4 parameters with your values):
curl --request POST \
--form 'token=TRIGGER_TOKEN' \
--form 'ref=GIT_REF' \
--form 'variables[_PIPELINE_FILE_NAME]=PIPELINE_CONFIGURATION_FILE_PATH' \
"http://app.dataops.live/api/v4/projects/PROJECT_ID/trigger/pipeline"
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
http://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" \
"http://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
http://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" \
"http://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
http://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" \
"http://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
http://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" \
"http://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
http://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" \
"http://app.dataops.live/api/v4/projects/PROJECT_ID/jobs/JOB_ID/trace"