Skip to content

Gateway

Use this section when you need documentation about gateway 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 gateway API when you need to manage gateway from automation scripts, CI/CD jobs, backend services, or internal tools rather than the Conductor UI.

Endpoint Description
POST /api/gateway/config/auth Create Auth Config for Gateway
PUT /api/gateway/config/auth/{id} Update Auth Config for Gateway
GET /api/gateway/config/auth/{id} Get Auth Config for Gateway
DELETE /api/gateway/config/auth/{id} Delete Auth Config for Gateway
GET /api/gateway/config/auth Get All Auth Config for Gateway
POST /api/gateway/config/services Create Gateway Service
PUT /api/gateway/config/services/{serviceId} Update Gateway Service
GET /api/gateway/config/services/{serviceId} Get Gateway Service
DELETE /api/gateway/config/services/{serviceId} Delete Gateway Service
GET /api/gateway/config/services Get All Gateway Services
PUT /api/gateway/config/services/{serviceId}/tags Add or Replace Tags in Gateway Service
GET /api/gateway/config/services/{serviceId}/tags Get Tags from Gateway Service
DELETE /api/gateway/config/services/{serviceId}/tags Delete Tags from Gateway Service
POST /api/gateway/config/services/{serviceId}/routes Create Route in Gateway Service
PUT /api/gateway/config/services/{serviceId}/routes Update Route in Gateway Service
GET /api/gateway/config/services/{serviceId}/routes/route Get Route in Gateway Service
DELETE /api/gateway/config/services/{serviceId}/routes Delete Route in Gateway Service
GET /api/gateway/config/services/{serviceId}/routes Get All Routes in Gateway Service
PUT /api/gateway/config/services/{serviceId}/routes/tags Add or Replace Tags in Gateway Service Routes
GET /api/gateway/config/services/{serviceId}/routes/tags Get Tags from Gateway Service Routes
DELETE /api/gateway/config/services/{serviceId}/routes/tags Delete Tags from Gateway Service Routes
GET /api/gateway/config/services/metrics Get Gateway Service Metrics

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 Auth Config for Gateway, Update Auth Config for Gateway, Get Auth Config for Gateway, Delete Auth Config for Gateway, Get All Auth Config for Gateway. 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