> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pads4.com/llms.txt
> Use this file to discover all available pages before exploring further.

# NDS.Services.Orchestration

## Overview

Workflow orchestration for PADS4 operations. Manages long-running background tasks, scheduled jobs, and cross-service workflows such as content publishing pipelines and bulk operations.

| Field           | Value                                                                          |
| --------------- | ------------------------------------------------------------------------------ |
| Swagger UI      | `https://<your-server>/rdx/NDS.Services.Orchestration/swagger/index.html`      |
| OpenAPI spec    | `https://<your-server>/rdx/NDS.Services.Orchestration/swagger/v1/swagger.json` |
| Base URL        | `https://<your-server>/rdx/NDS.Services.Orchestration`                         |
| Total endpoints | 37                                                                             |

***

## Authentication

All endpoints use the standard PADS4 session cookie. Obtain it once and reuse:

```bash theme={null}
# Log in and save the session cookie
curl -c cookies.txt -X POST 'https://<your-server>/api/v1/Account/Logon' \
  -H 'Content-Type: application/json' \
  -d '{"UserName": "admin", "Password": "yourpassword", "Domain": "yourdomain"}'

# Use the cookie on all subsequent requests
curl -b cookies.txt -X GET 'https://<your-server>/rdx/<ServiceName>/...'
```

> Replace `https://<your-server>` with your PADS4 server address and `<ServiceName>` with the service path shown above.

***

## Endpoint Reference

| Method | Path                                                         | Description                |
| ------ | ------------------------------------------------------------ | -------------------------- |
| `POST` | `/api/v1/orchestration/cluster/get`                          | Get Clusters               |
| `POST` | `/api/v1/orchestration/cluster/getGroups`                    | Get Clusters Groups        |
| `POST` | `/api/v1/orchestration/cluster/save`                         | Save Cluster               |
| `POST` | `/api/v1/orchestration/cluster/delete`                       | Delete Cluster             |
| `POST` | `/api/v1/orchestration/cluster/saveGroup`                    | Save Cluster Group         |
| `POST` | `/api/v1/orchestration/cluster/deleteGroup`                  | Delete Cluster Group       |
| `GET`  | `/api/v1/orchestration/Domain`                               | Get Domains                |
| `POST` | `/api/v1/orchestration/Domain`                               | Save Domain                |
| `POST` | `/api/v1/orchestration/Domain/multiple`                      | Save Domains               |
| `POST` | `/api/v1/orchestration/Domain/delete`                        | Delete Domain              |
| `POST` | `/api/v1/orchestration/Domain/uploadFile`                    | Upload File                |
| `POST` | `/api/v1/orchestration/management/logs`                      | Get Logs                   |
| `POST` | `/api/v1/orchestration/management/logex`                     | Get Logs Ex                |
| `POST` | `/api/v1/orchestration/server/get`                           | Get Servers                |
| `POST` | `/api/v1/orchestration/server/save`                          | Save Server                |
| `POST` | `/api/v1/orchestration/server/delete`                        | Delete Server              |
| `POST` | `/api/v1/orchestration/server/getDetails`                    | Get Server Details         |
| `POST` | `/api/v1/orchestration/server/getDomainServers`              | Get Domain Servers         |
| `POST` | `/api/v1/orchestration/server/associateDomain`               | Associate Domains          |
| `POST` | `/api/v1/orchestration/server/deleteDomainAssociation`       | Delete Domain Association  |
| `POST` | `/api/v1/orchestration/SystemDiag/events`                    | Get Events                 |
| `GET`  | `/api/v1/ReplicationClient/Diagnostics/contentTransferState` | Get Content Transfer State |
| `GET`  | `/api/v1/ReplicationClient/Diagnostics/busDiagnostics`       | Get Bus Diagnostics        |
| `GET`  | `/api/v1/diagnostics/toggles`                                | Get Toggles                |
| `GET`  | `/api/v1/diagnostics/configuration`                          | Get Config Section         |
| `GET`  | `/api/v1/diagnostics/configurationex`                        | Get Configuration          |
| `GET`  | `/api/v1/diagnostics/circuitbreakers`                        | Get Circuit Breakers       |
| `GET`  | `/api/v1/diagnostics/circuitbreakers/reset`                  | Reset Circuit Breaker      |
| `GET`  | `/api/v1/diagnostics/circuitbreakers/isolate`                | Isolate Circuit Breaker    |
| `POST` | `/api/v1/diagnostics/events`                                 | Get Events                 |
| `GET`  | `/api/v1/health`                                             | Get                        |
| `GET`  | `/api/v1/health/clean`                                       | Get Clean                  |
| `POST` | `/api/v1/Management/RequeueErrorMessages`                    | Requeue Error Messages     |
| `POST` | `/api/v1/Management/PurgeErrorMessages`                      | Purge Error Messages       |
| `GET`  | `/migration`                                                 | Get Migrations             |
| `POST` | `/migration`                                                 | Execute Migration          |
| `GET`  | `/version`                                                   | Get                        |

***

## Request & Response Examples

### POST `/api/v1/orchestration/cluster/get`

**Request:**

```bash theme={null}
curl -b cookies.txt -X POST 'https://<your-server>/rdx/NDS.Services.Orchestration/api/v1/orchestration/cluster/get' \
  -H 'Content-Type: application/json' \
  -d '{"PageIndex": 0, "PageSize": 20}'
```

**Response `200 OK`:**

```json theme={null}
{"Items": [], "TotalCount": 0, "PageIndex": 0, "PageSize": 20, "Code": "OK", "Succeeded": true}
```

***

### POST `/api/v1/orchestration/cluster/getGroups`

**Request:**

```bash theme={null}
curl -b cookies.txt -X POST 'https://<your-server>/rdx/NDS.Services.Orchestration/api/v1/orchestration/cluster/getGroups' \
  -H 'Content-Type: application/json' \
  -d '{"PageIndex": 0, "PageSize": 20}'
```

**Response `200 OK`:**

```json theme={null}
{"Items": [], "TotalCount": 0, "PageIndex": 0, "PageSize": 20, "Code": "OK", "Succeeded": true}
```

***

### POST `/api/v1/orchestration/cluster/save`

**Request:**

```bash theme={null}
curl -b cookies.txt -X POST 'https://<your-server>/rdx/NDS.Services.Orchestration/api/v1/orchestration/cluster/save' \
  -H 'Content-Type: application/json' \
  -d '{"PageIndex": 0, "PageSize": 20}'
```

**Response `200 OK`:**

```json theme={null}
{"Items": [], "TotalCount": 0, "PageIndex": 0, "PageSize": 20, "Code": "OK", "Succeeded": true}
```

***

### POST `/api/v1/orchestration/cluster/delete`

**Request:**

```bash theme={null}
curl -b cookies.txt -X POST 'https://<your-server>/rdx/NDS.Services.Orchestration/api/v1/orchestration/cluster/delete' \
  -H 'Content-Type: application/json' \
  -d '{"Ids": [1, 2, 3]}'
```

**Response `200 OK`:**

```json theme={null}
{"Items": [], "TotalCount": 0, "PageIndex": 0, "PageSize": 20, "Code": "OK", "Succeeded": true}
```

***

### POST `/api/v1/orchestration/cluster/saveGroup`

**Request:**

```bash theme={null}
curl -b cookies.txt -X POST 'https://<your-server>/rdx/NDS.Services.Orchestration/api/v1/orchestration/cluster/saveGroup' \
  -H 'Content-Type: application/json' \
  -d '{"PageIndex": 0, "PageSize": 20}'
```

**Response `200 OK`:**

```json theme={null}
{"Items": [], "TotalCount": 0, "PageIndex": 0, "PageSize": 20, "Code": "OK", "Succeeded": true}
```

***

### POST `/api/v1/orchestration/cluster/deleteGroup`

**Request:**

```bash theme={null}
curl -b cookies.txt -X POST 'https://<your-server>/rdx/NDS.Services.Orchestration/api/v1/orchestration/cluster/deleteGroup' \
  -H 'Content-Type: application/json' \
  -d '{"Ids": [1, 2, 3]}'
```

**Response `200 OK`:**

```json theme={null}
{"Items": [], "TotalCount": 0, "PageIndex": 0, "PageSize": 20, "Code": "OK", "Succeeded": true}
```

***

> Additional endpoints follow the same patterns shown above. See the Swagger UI for full parameter schemas.