# Netcracker V1 API

**Canonical:** https://apis.io/apis/netcracker/netcracker-v1-api/  
**Provider:** Netcracker — https://apis.io/providers/netcracker/  
**Base URL:** https://{apihub}.qubership.org  
**Documentation:** https://netcracker.github.io/apihub/

Netcracker V1 API is one of 40 APIs that [Netcracker](https://apis.io/providers/netcracker/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include v1. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

The V1 API from Netcracker — 22 operation(s) for v1.

## Operations (31)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/composite/v1/structure` | Create Composite Registration |
| DELETE | `/api/composite/v1/structure/{id}` | Destroy Composite Registrations |
| GET | `/api/composite/v1/structure/{id}` | Get Composite Registration By ID |
| GET | `/api/composite/v1/structures` | Get All Composite Registrations |
| DELETE | `/api/v1/auth/account/client` | Delete Client Account using Manager Role |
| POST | `/api/v1/auth/account/client` | Create Account |
| POST | `/api/v1/auth/account/manager` | Save Manager Account using Manager Role |
| GET | `/api/v1/auth/accounts` | Get All Accounts using Manager Role |
| GET | `/api/v1/bg-status` | Get Bg Status By Namespace using Agent Role |
| POST | `/api/v1/bg-status` | Apply Bg Status using Agent Role |
| POST | `/api/v1/config` | Apply Config using Agent Role |
| DELETE | `/api/v1/kafka/instance` | Unregister Kafka Instance using Manager Role |
| POST | `/api/v1/kafka/instance` | Register New Kafka Instance using Manager Role |
| PUT | `/api/v1/kafka/instance` | Update New Kafka Instance using Manager Role |
| PUT | `/api/v1/kafka/instance/default` | Set Default Kafka Instance using Manager Role |
| GET | `/api/v1/kafka/instances` | Get All Kafka Instances using Manager Role |
| DELETE | `/api/v1/kafka/topic` | Delete Topic using Agent Role |
| POST | `/api/v1/kafka/topic` | Get Or Create Topic using Agent Role |
| POST | `/api/v1/kafka/topic/get-by-classifier` | Get Topic By Classifier using Agent Role |
| POST | `/api/v1/kafka/topic/search` | Search Topics using Agent Role |
| DELETE | `/api/v1/namespace` | Delete Namespace using Manager Role |
| DELETE | `/api/v1/rabbit/instance` | Unregister Rabbit Instance using Manager Role |
| POST | `/api/v1/rabbit/instance` | Register New Rabbit Instance using Manager Role |
| PUT | `/api/v1/rabbit/instance` | Update Rabbit Instance using Manager Role |
| PUT | `/api/v1/rabbit/instance/default` | Set Default Rabbit Instance using Manager Role |
| GET | `/api/v1/rabbit/instances` | Get All Rabbit Instances using Manager Role |
| DELETE | `/api/v1/rabbit/vhost` | Delete VHost using Agent Role |
| POST | `/api/v1/rabbit/vhost` | Get Or Create VHost using Agent Role |
| POST | `/api/v1/rabbit/vhost/get-by-classifier` | Get VHost And Config By Classifier using Agent Role |
| POST | `/api/v1/synchronize-tenants` | Sync Tenants using Agent Role |
| GET | `/api/v1/tenants` | Get Tenants By Namespace using Agent Role |

## Machine-readable artifacts (14)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/netcracker/refs/heads/main/openapi/netcracker-v1-api-openapi.yml
- **Documentation** — https://netcracker.github.io/apihub/
- **APIReference** — https://github.com/Netcracker/qubership-apihub-backend/blob/develop/docs/api/APIHUB_API.yaml
- **SourceCode** — https://github.com/Netcracker/qubership-apihub-backend
- **GettingStarted** — https://netcracker.github.io/apihub/deploy/
- **Postman** — https://github.com/Netcracker/qubership-apihub-postman-collections
- **APIReference** — https://github.com/Netcracker/qubership-apihub-backend/blob/develop/docs/api/Admin%20API.yaml
- **Documentation** — https://github.com/Netcracker/qubership-maas
- **APIReference** — https://github.com/Netcracker/qubership-maas/blob/main/maas/maas-service/docs/swagger.yaml
- **SourceCode** — https://github.com/Netcracker/qubership-maas
- **SDKs** — https://raw.githubusercontent.com/api-evangelist/netcracker/refs/heads/main/packages/netcracker-packages.yml
- **Documentation** — https://github.com/Netcracker/qubership-dbaas
- **APIReference** — https://github.com/Netcracker/qubership-dbaas/blob/main/docs/OpenAPI.json
- **SourceCode** — https://github.com/Netcracker/qubership-dbaas

## Other Netcracker APIs (12)

- [Netcracker Admin API](https://apis.io/apis/netcracker/netcracker-admin-api/)
- [Netcracker Aggregated Database Administration No Namespace Controller V 3 API](https://apis.io/apis/netcracker/netcracker-aggregated-database-administration-no-namespace-controller-v-3-api/)
- [Netcracker AI Chat API](https://apis.io/apis/netcracker/netcracker-ai-chat-api/)
- [Netcracker API version controller API](https://apis.io/apis/netcracker/netcracker-api-version-controller-api/)
- [Netcracker Auth API](https://apis.io/apis/netcracker/netcracker-auth-api/)
- [Netcracker Backup & Restore API](https://apis.io/apis/netcracker/netcracker-backup-restore-api/)
- [Netcracker Backups administration API](https://apis.io/apis/netcracker/netcracker-backups-administration-api/)
- [Netcracker Balancing Rules Administration V3 API](https://apis.io/apis/netcracker/netcracker-balancing-rules-administration-v3-api/)
- [Netcracker Blue Green Controller V 1 API](https://apis.io/apis/netcracker/netcracker-blue-green-controller-v-1-api/)
- [Netcracker Changes API](https://apis.io/apis/netcracker/netcracker-changes-api/)
- [Netcracker Composite Controller API](https://apis.io/apis/netcracker/netcracker-composite-controller-api/)
- [Netcracker Config Controller V 1 API](https://apis.io/apis/netcracker/netcracker-config-controller-v-1-api/)

## Tags

v1

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/netcracker/netcracker-v1-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/netcracker/.