Skip to content

Integrations API Reference

Use this section when you need documentation about integrations api reference in Orkes Conductor.

Start with the overview pages, then move into the reference or tutorial that matches the workflow, worker, API, or integration you are implementing.

Quick reference

Use this integrations API when you need to manage integrations from automation scripts, CI/CD jobs, backend services, or internal tools rather than the Conductor UI.

Endpoint Description
POST /api/integrations/provider/{name} Create or Update Integration Provider
GET /api/integrations/provider/{name} Get Integration Provider
DELETE /api/integrations/provider/{name} Delete Integration Provider
PUT /api/integrations/provider/{name}/tags Add Tags to Integration Provider
GET /api/integrations/provider/{name}/tags Get Tags from Integration Provider
DELETE /api/integrations/provider/{name}/tags Delete Tags from Integration Provider
POST /api/integrations/provider/{name}/integration/{integration_name} Create or Update Integration Resource
GET /api/integrations/provider/{name}/integration/{integration_name} Get Integration Resource
DELETE /api/integrations/provider/{name}/integration/{integration_name} Delete Integration Resource
PUT /api/integrations/provider/{name}/integration/{integration_name}/tags Add Tags to Integration Resource
GET /api/integrations/provider/{name}/integration/{integration_name}/tags Get Tags from Integration Resource
DELETE /api/integrations/provider/{name}/integration/{integration_name}/tags Delete Tags from Integration Resource
POST /api/integrations/provider/{integration_provider}/integration/{integration_name}/prompt/{prompt_name} Associate Prompt with Integration Model
GET /api/integrations/provider/{integration_provider}/integration/{integration_name}/prompt List Integration Model Prompts
POST /api/integrations Save All Integrations
GET /api/integrations/ Get All Integrations
GET /api/integrations/provider Get All Integration Providers
GET /api/integrations/all Get Integration List

Authentication: every endpoint above requires Orkes Conductor API credentials with permission for the target resource. See individual pages for path/query parameters, request bodies, and response examples.

If you are unsure where to begin, start with Create or Update Integration Provider, Get Integration Provider, Delete Integration Provider, Add Tags to Integration Provider, Get Tags from Integration Provider. These pages cover the most common entry points for this section.

When to use this section

Use these pages to answer implementation questions, compare available primitives, and find the exact guide or reference page for the next step in your Orkes Conductor project.

Pages