How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Netcracker V1 API

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

Netcracker V1 API is one of 40 APIs that Netcracker publishes on the 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.

This API exposes 31 operations across 22 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0.

Requests are made against the base URL https://{apihub}.qubership.org.

31 operations 22 paths 25 schemas 7 DELETE7 GET13 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://{apihub}.qubership.org
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Netcracker V1 API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth).

Paths & Operations 31

Across 22 paths, the API surfaces 31 operations — 7 DELETE, 7 GET, 13 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

V1 31
POST
/api/composite/v1/structure
Create Composite Registration
Create body → 204409500
DELETE
/api/composite/v1/structure/{id}
Destroy Composite Registrations
DeleteById 1 param → 204404500
GET
/api/composite/v1/structure/{id}
Get Composite Registration By ID
GetById 1 param → 200404500
GET
/api/composite/v1/structures
Get All Composite Registrations
GetAll → 200500
DELETE
/api/v1/auth/account/client
Delete Client Account using Manager Role
DeleteClientAccount body → 204400500
POST
/api/v1/auth/account/client
Create Account
CreateAccount body → 200201400500
POST
/api/v1/auth/account/manager
Save Manager Account using Manager Role
SaveManagerAccount body → 201400403409500
GET
/api/v1/auth/accounts
Get All Accounts using Manager Role
GetAllAccounts → 200404500
GET
/api/v1/bg-status
Get Bg Status By Namespace using Agent Role
GetBgStatusByNamespace → 200404500
POST
/api/v1/bg-status
Apply Bg Status using Agent Role
ApplyBgStatus 1 param body → 200404500
POST
/api/v1/config
Apply Config using Agent Role
ApplyConfig 1 param body → 200404500
DELETE
/api/v1/kafka/instance
Unregister Kafka Instance using Manager Role
UnregisterKafkaInstance body → 200400404409500
POST
/api/v1/kafka/instance
Register New Kafka Instance using Manager Role
RegisterNewKafkaInstance body → 200400404409500
PUT
/api/v1/kafka/instance
Update New Kafka Instance using Manager Role
UpdateKafkaInstance body → 200400404409500
PUT
/api/v1/kafka/instance/default
Set Default Kafka Instance using Manager Role
SetDefaultKafkaInstance body → 200400404409500
GET
/api/v1/kafka/instances
Get All Kafka Instances using Manager Role
GetAllKafkaInstances → 200500
DELETE
/api/v1/kafka/topic
Delete Topic using Agent Role
DeleteTopic 1 param body → 200400404405500
POST
/api/v1/kafka/topic
Get Or Create Topic using Agent Role
GetOrCreateTopicV1 1 param body → 200400409410500
POST
/api/v1/kafka/topic/get-by-classifier
Get Topic By Classifier using Agent Role
GetTopicByClassifierV1 1 param body → 200400403404500
POST
/api/v1/kafka/topic/search
Search Topics using Agent Role
SearchTopicsV1 1 param body → 200400500
DELETE
/api/v1/namespace
Delete Namespace using Manager Role
DeleteNamespace body → 200400500
DELETE
/api/v1/rabbit/instance
Unregister Rabbit Instance using Manager Role
UnregisterRabbitInstance body → 200400404409500
POST
/api/v1/rabbit/instance
Register New Rabbit Instance using Manager Role
RegisterNewRabbitInstance body → 200400404409500
PUT
/api/v1/rabbit/instance
Update Rabbit Instance using Manager Role
UpdateRabbitInstance body → 200400404409500
PUT
/api/v1/rabbit/instance/default
Set Default Rabbit Instance using Manager Role
SetDefaultRabbitInstance body → 200400404409500
GET
/api/v1/rabbit/instances
Get All Rabbit Instances using Manager Role
GetAllRabbitInstances → 200500
DELETE
/api/v1/rabbit/vhost
Delete VHost using Agent Role
DeleteVHost 1 param body → 204400404500
POST
/api/v1/rabbit/vhost
Get Or Create VHost using Agent Role
GetOrCreateVHost 1 param body → 200201400403404409500
POST
/api/v1/rabbit/vhost/get-by-classifier
Get VHost And Config By Classifier using Agent Role
GetVHostAndConfigByClassifier 1 param body → 200204400404500
POST
/api/v1/synchronize-tenants
Sync Tenants using Agent Role
SyncTenants 1 param body → 200500
GET
/api/v1/tenants
Get Tenants By Namespace using Agent Role
GetTenantsByNamespace 1 param → 200404500

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are model.TopicRegistrationRespDto (12 properties), model.TopicSearchRequest (7 properties), model.Account (6 properties), model.TopicSettings (6 properties). Each schema is shown below with its type and property counts.

model.ClientAccountDto
object
4 properties
model.TopicSearchRequest
object
7 properties
controller.VhostAndConfigResult
object
2 properties
model.ManagerAccountDto
object
2 properties
model.TopicRegistrationRespDto
object
12 properties
model.Namespace
object
1 property
model.TopicDeletionResp
object
2 properties
model.Account
object
6 properties
model.VHostRegistrationResponse
object
4 properties
model.TopicDeletionError
object
2 properties
v1.RegistrationResponse
object
2 properties
model.KafkaCredentials
object
5 properties
controller.Instance
object
1 property
model.VHostRegistrationReqDto
object
2 properties 1 required
model.SearchForm
object
5 properties
model.BgStatus
object
5 properties
v1.RegistrationRequest
object
2 properties 2 required
model.RabbitInstance
object
6 properties
model.TopicSettings
object
6 properties
model.CpDeploymentVersion
object
4 properties
model.Tenant
object
3 properties
model.Classifier
object
3 properties 2 required
model.RabbitEntities
object
3 properties
model.KafkaInstance
object
6 properties
model.SyncTenantsResp
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netcracker-v1-api-openapi.yml Raw ↑

Other APIs Netcracker publishes across the network.

Netcracker Admin API
Netcracker Aggregated Database Administration No Namespace Controller V 3 API
Netcracker AI Chat API
Netcracker API version controller API
Netcracker Auth API
Netcracker Backup & Restore API
Netcracker Backups administration API
Netcracker Balancing Rules Administration V3 API
Netcracker Blue Green Controller V 1 API
Netcracker Changes API
Netcracker Composite Controller API
Netcracker Config Controller V 1 API
Where this information came from

This is an independent, third-party profile of Netcracker V1 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.