# migrations — NCM API

GET and POST operations for NetCloud Organizations migrations.

Base URL: https://api.cradlepointecm.com

## Authentication

This is a v3 endpoint (`/api/v3/` path). Send a Bearer token on every request:

```http
Authorization: Bearer <token>
```

Tokens are generated in the NCM UI under API Keys. The v2 and v3 auth schemes are NOT interchangeable: v2 API-key headers are rejected on v3 endpoints.

### GET /api/v3/organizations/migrations

api_v3_organizations_migrations_list

Return a list of organization migrations

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| filter[source] | query | string | no | Filter migrations where this tenant is the source. Mutually exclusive with filter[target]; exactly one is required. |
| filter[status] | query | string (completed | failed | in_progress | initializing | ready_to_use) | no | Comma-separated list of statuses to filter by. |
| filter[target] | query | string | no | Filter migrations where this tenant is the target. Mutually exclusive with filter[source]; exactly one is required. |
| filter[type] | query | string (create | create_organizations | elevate | elevate_organizations | manage | merge | merge_organizations) | no | Filter by migration type. |
| page[after] | query | string | no | Cursor for next page. |
| page[before] | query | string | no | Cursor for prior page. |
| page[size] | query | integer | no | Number of results to return per page. |
| sort | query | string (-created_at | -updated_at | created_at | updated_at) | no | Sort field. Prefix with '-' for descending order. Default: created_at. |

**Example request**

```bash
curl "https://api.cradlepointecm.com/api/v3/organizations/migrations" \
  -H "Authorization: Bearer <token>"
```

**Response 200**

### POST /api/v3/organizations/migrations

api_v3_organizations_migrations_create

Create an organization migration

**Request body**

**Example request**

```bash
curl -X POST "https://api.cradlepointecm.com/api/v3/organizations/migrations" \
  -H "Authorization: Bearer <token>"
```

**Response 202**

### GET /api/v3/organizations/migrations/{id}

api_v3_organizations_migrations_retrieve

Get a single organization migration

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| id | path | string | yes |  |

**Example request**

```bash
curl "https://api.cradlepointecm.com/api/v3/organizations/migrations/{id}" \
  -H "Authorization: Bearer <token>"
```

**Response 200**
