How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Talend Crawler API

The Crawler API from Talend — 6 operation(s) for crawler.

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

Tagged areas include Crawler. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 10 operations across 6 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 2021-03.

Requests are made against 5 base URLs: https://api.eu.cloud.talend.com, https://api.ap.cloud.talend.com, https://api.us.cloud.talend.com, https://api.au.cloud.talend.com, https://api.us-west.cloud.talend.com.

10 operations 6 paths 22 schemas 1 DELETE4 GET1 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 10

Across 6 paths, the API surfaces 10 operations — 1 DELETE, 4 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Crawler 10
GET
/connections/crawlers
Retrieve all the crawlers of a tenant
getApiV1Crawlers 6 params → 200401403500
POST
/connections/crawlers
Create a new crawler
postApiV1Crawlers 2 params body → 201401403409500
GET
/connections/crawlers/{crawlerId}
Get a crawler by its ID
getApiV1CrawlersCrawlerid 4 params → 200401403404500
PUT
/connections/crawlers/{crawlerId}
Update the tables and views selection of an existing crawler
putApiV1CrawlersCrawlerid 3 params body → 200401403404409500
DELETE
/connections/crawlers/{crawlerId}
Delete a crawler
deleteApiV1CrawlersCrawlerid 3 params → 204401403404409500
PATCH
/connections/crawlers/{crawlerId}
Update the name and description of a crawler
patchApiV1CrawlersCrawlerid 3 params body → 200401403404409500
POST
/connections/crawlers/{crawlerId}/run
Run a crawler
postApiV1CrawlersCrawleridRun 3 params → 202401403404500
POST
/connections/crawlers/{crawlerId}/end
End a crawler while it is running
postApiV1CrawlersCrawleridEnd 3 params → 202401403404500
GET
/connections/crawlers/{crawlerId}/datasets
Retrieve all the statuses of the datasets related to a crawler
getApiV1CrawlersCrawleridDatasets 5 params → 200401403404500503
GET
/connections/crawlers/{crawlerId}/errors.log
Get the error log file
getApiV1CrawlersCrawleridErrors.log 3 params → 200401403

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are CrawlerComplete (13 properties), Status (10 properties), CrawledDataset (9 properties), CrawlerLight (5 properties). Each schema is shown below with its type and property counts.

NotAuthorized
object
The user has been authenticated but doesn't have the entitlement for this service.
2 properties 1 required
Status
object
This object contains informations about the crawler status
10 properties 6 required
Metadata_infos
object
This objects contains the metadata of an entity according to the context of the call. Exemple : indicate if an object is a table or a view.
CreateCrawlerResponse
object
Contains the response following a crawler creation request. The object contains the ID of the crawler created.
1 property 1 required
CrawlerModel
This object represents a whole crawler. It has two formats : either complete or light.
UpdateCrawlerRequest
object
Describe the elements to update on the crawler as the name, description and the tables/views selection.
3 properties 1 required
CrawlerLight
object
This object represents a crawler in the light version (only contain the status).
5 properties 4 required
AlreadyExist
object
A crawler already exists for this connection. You can only have one crawler per connection.
2 properties 1 required
EntityType
string
Entity type used for the NotFound data type in order to indicate the type of the object that hasn't been found.
PaginatedResources_CrawledDataset
object
This objects contains the datasets related to a crawler in a paginated context.
4 properties 3 required
CrawlerComplete
object
This object represents a crawler in the complete version.
13 properties 6 required
RunStatus
string
This object contains the different run status of the crawler.
PatchCrawlerRequest
object
This object is used when the user wants to update the name and the description of the crawler. Those fields will replace the current ones once the update will…
2 properties
AlreadyRunning
object
This entity indicates that the crawler is already running and provides the crawler ID.
2 properties 1 required
Sharing
object
This object indicate the sharing informations.
3 properties 3 required
PaginatedResources_CrawlerModel
object
This object represents a whole crawler but in a paginated context.
4 properties 3 required
NotAuthenticated
object
The user has not been authenticated.
2 properties 1 required
ServerError
object
The server encountered an error during the processing of the request.
2 properties 1 required
CreateCrawlerRequest
object
Describe the crawler about to be created with the name, description, tables and views selection, user and group for the sharing policies.
5 properties 2 required
NotFound
object
Generic response payload when an object hasn't been found. The entityType gives more information about the object.
3 properties 2 required
ExportStatus
string
this object contains the different statuses of a dataset in a crawler context.
CrawledDataset
object
This object represents a datasets related to a crawler.
9 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

talend-crawler-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 Plans API
Talend Promotion Executions API
Talend Promotions API
Talend Remote Engine Clusters API
Where this information came from

This is an independent, third-party profile of Talend Crawler API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.