Netcracker

Netcracker Rabbit API

The Rabbit API from Netcracker — 7 operation(s) for rabbit.

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 10

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/v2/rabbit/recovery/{namespace} Recover Namespace using Agent Role #
GET /api/v2/rabbit/validations Validate Rabbit Configs using Agent Role #

Documentation

📖
Documentation
https://netcracker.github.io/apihub/
📖
APIReference
https://github.com/Netcracker/qubership-apihub-backend/blob/develop/docs/api/APIHUB_API.yaml
📖
GettingStarted
https://netcracker.github.io/apihub/deploy/
📖
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
📖
Documentation
https://github.com/Netcracker/qubership-dbaas
📖
APIReference
https://github.com/Netcracker/qubership-dbaas/blob/main/docs/OpenAPI.json

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/netcracker/refs/heads/main/openapi/netcracker-rabbit-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/Netcracker/qubership-apihub-backend
🔗
Postman
https://github.com/Netcracker/qubership-apihub-postman-collections
🔗
SourceCode
https://github.com/Netcracker/qubership-maas
🔗
SDKs
https://raw.githubusercontent.com/api-evangelist/netcracker/refs/heads/main/packages/netcracker-packages.yml
🔗
SourceCode
https://github.com/Netcracker/qubership-dbaas

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/netcracker:netcracker-rabbit-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

netcracker-rabbit-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact: {}
  description: API for Maas Service.
  title: Maas Service Rabbit API
tags:
- name: Rabbit
paths:
  /api/v1/rabbit/instance:
    delete:
      description: Unregister Rabbit Instance
      operationId: UnregisterRabbitInstance
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/model.RabbitInstance'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
      security:
      - BasicAuth:
        - manager
      summary: Unregister Rabbit Instance using Manager Role
      tags:
      - Rabbit
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/controller.Instance'
        description: Instance
        required: true
    post:
      description: Register New Rabbit Instance
      operationId: RegisterNewRabbitInstance
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/model.RabbitInstance'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
      security:
      - BasicAuth:
        - manager
      summary: Register New Rabbit Instance using Manager Role
      tags:
      - Rabbit
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/model.RabbitInstance'
        description: RabbitInstance
        required: true
    put:
      description: Update Rabbit Instance
      operationId: UpdateRabbitInstance
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/model.RabbitInstance'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
      security:
      - BasicAuth:
        - manager
      summary: Update Rabbit Instance using Manager Role
      tags:
      - Rabbit
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/model.RabbitInstance'
        description: RabbitInstance
        required: true
  /api/v1/rabbit/instance/default:
    put:
      description: Set Default Rabbit Instance
      operationId: SetDefaultRabbitInstance
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/model.RabbitInstance'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
      security:
      - BasicAuth:
        - manager
      summary: Set Default Rabbit Instance using Manager Role
      tags:
      - Rabbit
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/model.RabbitInstance'
        description: RabbitInstance
        required: true
  /api/v1/rabbit/instances:
    get:
      description: Get All Rabbit Instances
      operationId: GetAllRabbitInstances
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/model.RabbitInstance'
                type: array
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
      security:
      - BasicAuth:
        - manager
      summary: Get All Rabbit Instances using Manager Role
      tags:
      - Rabbit
  /api/v1/rabbit/vhost:
    delete:
      description: Delete VHost
      operationId: DeleteVHost
      parameters:
      - description: X-Origin-Namespace
        in: header
        name: X-Origin-Namespace
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
      security:
      - BasicAuth:
        - agent
      summary: Delete VHost using Agent Role
      tags:
      - Rabbit
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/model.SearchForm'
        description: SearchForm
        required: true
    post:
      description: Get Or Create VHost
      operationId: GetOrCreateVHost
      parameters:
      - description: cloudbss311-platform-core-support-dev3
        in: header
        name: X-Origin-Namespace
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/model.VHostRegistrationResponse'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/model.VHostRegistrationResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
      security:
      - BasicAuth:
        - agent
      summary: Get Or Create VHost using Agent Role
      tags:
      - Rabbit
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/model.VHostRegistrationReqDto'
        description: VHostRegistrationReqDto
        required: true
  /api/v1/rabbit/vhost/get-by-classifier:
    post:
      description: Set Default Rabbit Instance
      operationId: GetVHostAndConfigByClassifier
      parameters:
      - description: cloudbss311-platform-core-support-dev3
        in: header
        name: X-Origin-Namespace
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controller.VhostAndConfigResult'
        '204':
          description: No Content
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
      security:
      - BasicAuth:
        - agent
      summary: Get VHost And Config By Classifier using Agent Role
      tags:
      - Rabbit
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/model.Classifier'
        description: Classifier
        required: true
  /api/v2/rabbit/recovery/{namespace}:
    post:
      description: Recover Namespace
      operationId: RecoverNamespace
      parameters:
      - description: X-Origin-Namespace
        in: header
        name: X-Origin-Namespace
        required: true
        schema:
          type: string
      - description: namespace
        in: path
        name: namespace
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
      security:
      - BasicAuth:
        - agent
      summary: Recover Namespace using Agent Role
      tags:
      - Rabbit
  /api/v2/rabbit/validations:
    get:
      description: Validate Rabbit Configs
      operationId: ValidateRabbitConfigs
      parameters:
      - description: X-Origin-Namespace
        in: header
        name: X-Origin-Namespace
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                additionalProperties:
                  items:
                    $ref: '#/components/schemas/model.LazyBindingDto'
                  type: array
                type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
      security:
      - BasicAuth:
        - agent
      summary: Validate Rabbit Configs using Agent Role
      tags:
      - Rabbit
components:
  schemas:
    controller.VhostAndConfigResult:
      properties:
        entities:
          $ref: '#/components/schemas/model.RabbitEntities'
        vhost:
          $ref: '#/components/schemas/model.VHostRegistrationResponse'
      type: object
    model.VHostRegistrationReqDto:
      properties:
        classifier:
          $ref: '#/components/schemas/model.Classifier'
        instance:
          example: <[optional] rabbitmq instance for virtual host. if not specified default instance will be used>
          type: string
      required:
      - classifier
      type: object
    model.Classifier:
      properties:
        name:
          type: string
        namespace:
          type: string
        tenantId:
          type: string
      required:
      - name
      - namespace
      type: object
    model.LazyBindingDto:
      properties:
        entity:
          additionalProperties: true
          type: object
        exchangeVersion:
          example: v1
          type: string
        queueVersion:
          example: v1
          type: string
        vhost:
          example: maas.core-dev.test
          type: string
      type: object
    model.RabbitInstance:
      properties:
        amqpUrl:
          example: amqp://127.0.0.1:5672
          type: string
        apiUrl:
          example: http://127.0.0.1:15672/api
          type: string
        default:
          example: true
          type: boolean
        id:
          example: fd02de58-da04-4842-a258-37ebe4e5ac1e
          type: string
        password:
          example: guest
          type: string
        user:
          example: guest
          type: string
      type: object
    model.SearchForm:
      properties:
        classifier:
          $ref: '#/components/schemas/model.Classifier'
        instance:
          type: string
        namespace:
          example: cloudbss311-platform-core-support-dev3
          type: string
        user:
          type: string
        vhost:
          type: string
      type: object
    model.VHostRegistrationResponse:
      properties:
        apiUrl:
          example: http://127.0.0.1:15672/api
          type: string
        cnn:
          example: amqp://127.0.0.1:5672/namespace.test12
          type: string
        password:
          example: plain:504a449065924332b062c4a84e830cbe
          type: string
        username:
          example: 9757343a78a04057a07ee4215f1b1355
          type: string
      type: object
    controller.Instance:
      properties:
        id:
          example: maas-rabbitmq-code-dev
          type: string
      type: object
    model.RabbitEntities:
      properties:
        bindings:
          items: {}
          type: array
        exchanges:
          description: 'todo: rabbit entites should be refactored to specific type []map[string]interface{}'
          items: {}
          type: array
        queues:
          items: {}
          type: array
      type: object
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic