Skip to main content

Create a MongoDB instance​

Select

SaaS
Customer Managed

This operation is used to create a MongoDB instance.

Request Body
  • clientInfo object
  • clientType string

    Default value: DISTRIBUTED_IDA

    internal field

  • distributedClusterInstanceProperties object
  • instance object
  • instanceId integer required
  • instanceName string required
  • applicationId integer

    Default value: 64

  • clientName string required
  • opType string

    Default value: SET

  • clusterType string

    Default value: MONGODB

  • clusterConfig object
  • mdbConfig object
  • adminUser object required
  • userName string required

    If authentication is enabled on the cluster

  • password string required
  • masterNode object
  • client object
  • clientId integer required

    Master node client ID

  • clientName string required

    Master node client name

  • hostName string required

    Master node hostname

  • portNumber integer required

    Port number of the MongoDB server/Mongos process on the master node

  • osUser string required

    OS user used for impersonation

  • binPath string required

    Path where MongoDB binaries are present on the master node

  • plan object
  • planId integer required
  • planName string required

    Name of the plan associated with the MongoDB instance

  • planType integer
  • planSubtype integer
  • planSummary string
  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
  • entity object
  • clientName string

    Master node client name

Responses

OK

Schema
  • response object
  • errorCode integer
  • entity object
  • clientId integer
  • clientName string
  • instanceId integer
  • _type_ integer
POST /pseudoclient

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "clientInfo": {

    "clientType": "DISTRIBUTED_IDA",

    "distributedClusterInstanceProperties": {

      "instance": {

        "instanceId": 0,

        "instanceName": "string",

        "applicationId": 64,

        "clientName": "string"

      },

      "opType": "SET",

      "clusterType": "MONGODB",

      "clusterConfig": {

        "mdbConfig": {

          "adminUser": {

            "userName": "string",

            "password": "string"

          },

          "masterNode": {

            "client": {

              "clientId": 0,

              "clientName": "string"

            },

            "hostName": "string",

            "portNumber": 0,

            "osUser": "string",

            "binPath": "string"

          }

        }

      }

    },

    "plan": {

      "planId": 0,

      "planName": "string",

      "planType": 0,

      "planSubtype": 0,

      "planSummary": "string",

      "entityInfo": {

        "companyId": 0,

        "companyName": "string",

        "multiCommcellId": 0

      }

    }

  },

  "entity": {

    "clientName": "string"

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/pseudoClient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientInfo": {
    "clientType": "DISTRIBUTED_IDA",
    "distributedClusterInstanceProperties": {
      "instance": {
        "instanceId": 0,
        "instanceName": "string",
        "applicationId": 64,
        "clientName": "string"
      },
      "opType": "SET",
      "clusterType": "MONGODB",
      "clusterConfig": {
        "mdbConfig": {
          "adminUser": {
            "userName": "string",
            "password": "string"
          },
          "masterNode": {
            "client": {
              "clientId": 0,
              "clientName": "string"
            },
            "hostName": "string",
            "portNumber": 0,
            "osUser": "string",
            "binPath": "string"
          }
        }
      }
    },
    "plan": {
      "planId": 0,
      "planName": "string",
      "planType": 0,
      "planSubtype": 0,
      "planSummary": "string",
      "entityInfo": {
        "companyId": 0,
        "companyName": "string",
        "multiCommcellId": 0
      }
    }
  },
  "entity": {
    "clientName": "string"
  }
}'