Skip to main content

Get All Task Definitions

Endpoint: GET /api/metadata/taskdefs

Gets all the task definitions in the cluster.

Query parameters​

ParameterDescriptionTypeRequired/Optional
accessThe access level being requested. Supported values: READ, CREATE, UPDATE, EXECUTE, and DELETE. Default is READ.stringOptional.
metadataWhether metadata (such as tags) should be included in the response. Default is false.booleanOptional.
tagKeyOption to filter based on the tag key associated with the task definitions.stringOptional.
tagValueOption to filter based on the tag value associated with the task definitions.stringOptional.

Response​

Returns an array containing all the task definitions in the cluster.

Examples​

Get all task definitions with a specific tag​

Get all task definitions with a specific tag

Request

curl -X 'GET' \
  'https://<YOUR-CLUSTER>/api/metadata/taskdefs?access=READ&metadata=false&tagKey=team&tagValue=engineering' \
  -H 'accept: */*' \
  -H 'X-Authorization: <TOKEN>'

Response

[
  {
    "ownerApp": "string",
    "createTime": 0,
    "updateTime": 1735634595302,
    "createdBy": "string",
    "updatedBy": "john.doe@acme.com",
    "name": "string",
    "description": "string",
    "retryCount": 0,
    "timeoutSeconds": 0,
    "inputKeys": [
      "string"
    ],
    "outputKeys": [
      "string"
    ],
    "timeoutPolicy": "RETRY",
    "retryLogic": "FIXED",
    "retryDelaySeconds": 0,
    "responseTimeoutSeconds": 1,
    "concurrentExecLimit": 0,
    "inputTemplate": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "rateLimitPerFrequency": 0,
    "rateLimitFrequencyInSeconds": 0,
    "isolationGroupId": "string",
    "executionNameSpace": "string",
    "ownerEmail": "john.doe@acme.com",
    "pollTimeoutSeconds": 0,
    "backoffScaleFactor": 1,
    "totalTimeoutSeconds": 0,
    "inputSchema": {
      "ownerApp": "string",
      "createTime": 0,
      "updateTime": 0,
      "createdBy": "string",
      "updatedBy": "string",
      "name": "string-11",
      "version": 0,
      "type": "JSON",
      "data": {
        "additionalProp1": {},
        "additionalProp2": {},
        "additionalProp3": {}
      },
      "externalRef": "string"
    },
    "outputSchema": {
      "ownerApp": "string",
      "createTime": 0,
      "updateTime": 0,
      "createdBy": "string",
      "updatedBy": "string",
      "name": "string",
      "version": 0,
      "type": "JSON",
      "data": {
        "additionalProp1": {},
        "additionalProp2": {},
        "additionalProp3": {}
      },
      "externalRef": "string"
    },
    "enforceSchema": true,
    "overwriteTags": true,
    "tags": [
      {
        "key": "team",
        "value": "engineering"
      }
    ]
  }
]