Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Talend Plans API

The Plans API from Talend — 2 operation(s) for plans.

Talend Plans API is one of 18 APIs that Talend publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Plans. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 5 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 2021-03.

Requests are made against a single base URL, https://api.{region}.cloud.talend.com.

5 operations 2 paths 2 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2021-03
Base URL
https://api.{region}.cloud.talend.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Talend Plans API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Bearer token from Talend Cloud personal access token or service account token

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Plans 5
GET
/orchestration/executables/plans
List Plans
listPlans 1 param → 200
POST
/orchestration/executables/plans
Create Plan
createPlan body → 201
GET
/orchestration/executables/plans/{planId}
Get Plan
getPlan 1 param → 200
PUT
/orchestration/executables/plans/{planId}
Update Plan
updatePlan 1 param body → 200
DELETE
/orchestration/executables/plans/{planId}
Delete Plan
deletePlan 1 param → 204

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Plan (7 properties), PlanCreate (4 properties). Each schema is shown below with its type and property counts.

PlanCreate
object
4 properties 2 required
Plan
object
An ordered sequence of tasks in Talend Cloud
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

talend-plans-api-openapi.yml Raw ↑

Other APIs Talend publishes across the network.

Talend Cloud Identities Management API
Talend Cloud Audit Logs API
Talend Cloud Connections API
Talend Cloud Execution Logs API
Talend Artifacts API
Talend Connections API
Talend Environments API
Talend Plan Executions API
Talend Promotion Executions API
Talend Promotions API
Talend Remote Engine Clusters API
Talend Remote Engines API