Skip to content

Remote Services API Reference

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

Endpoint Description
POST /api/registry/service Create Service
POST /api/registry/service/{name}/clone Clone Service
GET /api/registry/service/{name} Get Service
DELETE /api/registry/service/{name} Delete Service
GET /api/registry/service Get All Services
GET /api/registry/service/{name}/discover Discover and Register Service Endpoints
POST /api/registry/service/{registryName}/methods Add Method to Service
DELETE /api/registry/service/{registryName}/methods Remove Method from Service
GET /api/registry/service/{name}/circuit-breaker/status Get Circuit Breaker Status
POST /api/registry/service/{name}/circuit-breaker/open Open Circuit Breaker
POST /api/registry/service/{name}/circuit-breaker/close Close Circuit Breaker
POST /api/registry/service/protos/{registryName}/{filename} Upload Proto File to gRPC Service
GET /api/registry/service/protos/{registryName}/{filename} Get Proto File from gRPC Service
DELETE /api/registry/service/protos/{registryName}/{filename} Delete Proto File from gRPC Service
GET /api/registry/service/protos/{registryName} Get All Proto Files from gRPC Service

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 Service, Clone Service, Get Service, Delete Service, Get All Services. 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