Team Tasks Route
On this page

Team Tasks Route

Name Method Endpoint
Update, replace, or create new using Tekton Task YAML PUT /api/v2/team/{team}/task/{name}
Create a new Task Template using Tekton Task YAML POST /api/v2/team/{team}/task
Delete a Team Task DELETE /api/v2/team/{team}/task/{name}
Retrieve a specific task as Tekton Task YAML. If no version specified, the latest version is returned. GET /api/v2/team/{team}/task/{name}
Retrieve the changlog GET /api/v2/team/{team}/task/{name}/changelog
Search for Tasks. If teams are provided it will query the teams. If no teams are provided it will query Global Task Templates GET /api/v2/team/{team}/task/query
Validate Tekton Task YAML POST /api/v2/team/{team}/task/validate

Update, replace, or create new using Tekton Task YAML

PUT /api/v2/team/{team}/task/{name}?replace=true

The name must only contain alphanumeric and - characeters. If the name exists, apply will create a new version.

Request Parameters

Name Type Required Description Notes Example
name String true Name of Task Defaults to null. name_example
team String true Owning team name. Defaults to null. my-amazing-team
replace Boolean false Replace existing version Defaults to false. true

Request Body

Schema Required
Task true

Authorization

Note: this section and the documentation around what is required is still actively being updated.

No authorization required

Request Headers

  • Content-Type: application/json, application/x-yaml
  • Accept: */*

Response

Task

Create a new Task Template using Tekton Task YAML

POST /api/v2/team/{team}/task

The name needs to be unique and must only contain alphanumeric and - characeters.

Request Parameters

Name Type Required Description Notes Example
team String true Owning team name. Defaults to null. my-amazing-team

Request Body

Schema Required
Task true

Authorization

Note: this section and the documentation around what is required is still actively being updated.

No authorization required

Request Headers

  • Content-Type: application/json, application/x-yaml
  • Accept: */*

Response

Task

Delete a Team Task

DELETE /api/v2/team/{team}/task/{name}

Request Parameters

Name Type Required Description Notes Example
team String true Owning team name. Defaults to null. my-amazing-team
name String true Name of Task Defaults to null. name_example

Request Body

This endpoint does not require a request body.

Authorization

Note: this section and the documentation around what is required is still actively being updated.

No authorization required

Request Headers

  • Content-Type: Not defined
  • Accept: Not defined

Response

null (empty response body)

Retrieve a specific task as Tekton Task YAML. If no version specified, the latest version is returned.

GET /api/v2/team/{team}/task/{name}?version=56

Request Parameters

Name Type Required Description Notes Example
name String true Name of Task Defaults to null. name_example
team String true Owning team name. Defaults to null. my-amazing-team
version Integer false Task Version Defaults to null. 56

Request Body

This endpoint does not require a request body.

Authorization

Note: this section and the documentation around what is required is still actively being updated.

No authorization required

Request Headers

  • Content-Type: Not defined
  • Accept: */*

Response

Task

Retrieve the changlog

GET /api/v2/team/{team}/task/{name}/changelog

Retrieves each versions changelog and returns them all as a list.

Request Parameters

Name Type Required Description Notes Example
team String true Owning team name. Defaults to null. my-amazing-team
name String true Name of Task Defaults to null. name_example

Request Body

This endpoint does not require a request body.

Authorization

Note: this section and the documentation around what is required is still actively being updated.

No authorization required

Request Headers

  • Content-Type: Not defined
  • Accept: */*

Response

List

Search for Tasks. If teams are provided it will query the teams. If no teams are provided it will query Global Task Templates

GET /api/v2/team/{team}/task/query?labels=,statuses=active,inactive,names=switch,event-wait,limit=10,page=0,sort=ASC

Request Parameters

Name Type Required Description Notes Example
team String true Owning team name. Defaults to null. my-amazing-team
limit Integer true Result Size Defaults to null. 10
page Integer true Page Number Defaults to null. 0
sort String true Ascending (ASC) or Descending (DESC) sort on creationDate Defaults to Optional[ASC]. Enum: [ASC, DESC] ASC
labels List false List of url encoded labels. For example Organization=Boomerang,customKey=test would be encoded as Organization%3DBoomerang,customKey%3Dtest) Defaults to null.
statuses List false List of statuses to filter for. Defaults to null. active,inactive
names List false List of Task Names to filter for. Defaults to all. Defaults to null. switch,event-wait

Request Body

This endpoint does not require a request body.

Authorization

Note: this section and the documentation around what is required is still actively being updated.

No authorization required

Request Headers

  • Content-Type: Not defined
  • Accept: */*

Response

TaskResponsePage

Validate Tekton Task YAML

POST /api/v2/team/{team}/task/validate

Validates the Task YAML as a Tekton Task

Request Parameters

Name Type Required Description Notes Example

Request Body

Schema Required
TektonTask true

Authorization

Note: this section and the documentation around what is required is still actively being updated.

No authorization required

Request Headers

  • Content-Type: application/x-yaml
  • Accept: Not defined

Response

null (empty response body)