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

Weld Orchestrations API

The Orchestrations API from Weld — 3 operation(s) for orchestrations.

Weld Orchestrations API is one of 13 APIs that Weld publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.0.0, at version 0.1.

Requests are made against a single base URL, https://connect.weld.app.

3 operations 3 paths 3 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1
Base URL
https://connect.weld.app
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Weld Orchestrations API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (api_key). By default, every request must be authenticated.

  • api_key — The API key from Settings - API Keys

Paths & Operations 3

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

Orchestrations 3
GET
/orchestrations
List Orchestrations
OrchestrationsOpenApiController_getOrchestrations 2 params → 200
GET
/orchestrations/{id}
Get Orchestration
OrchestrationsOpenApiController_getOrchestration 1 param → 200404
POST
/orchestrations/{id}/request_run
Request Orchestration Run
OrchestrationsOpenApiController_requestRun 1 param → 200404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are OrchestrationRunDto (6 properties), PagedOrchestrationDto (3 properties), OrchestrationDto (2 properties). Each schema is shown below with its type and property counts.

OrchestrationRunDto
object
6 properties 4 required
PagedOrchestrationDto
object
3 properties 2 required
OrchestrationDto
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weld-orchestrations-api-openapi.yml Raw ↑

Other APIs Weld publishes across the network.

Weld Connection Bridge API
Weld Connections API
Weld Custom Reports API
Weld ELT Stream Runs API
Weld ELT Streams API
Weld ELT Syncs API
Weld Integrations API
Weld Orchestration Runs API
Weld Reverse ETL Failed Records API
Weld Reverse ETL Sync Runs API
Weld Reverse ETL Syncs API
Weld Transforms API