Create YugabyteDB instance

Select

SaaS

Customer Managed

This API is used to create a YugabyteDB instance

application/json

Request Body

• createPseudoClientRequest object

  clientInfo object

  clientType integer

  plan object

  planName string

  subclientInfo object

  useLocalContent boolean

  contentOperationType integer

  content object[]

  path string

  distributedClusterInstanceProperties object

  clusterType integer

  opType integer

  instance object

  instanceId integer

  instanceName string

  clientName string

  applicationId integer

  Default value: 64

  clusterConfig object

  yugabytedbConfig object

  dbHost string

  apiToken string

  customer object

  name string

  uuid string

  universe object

  name string

  uuid string

  customerConfig object

  name string

  uuid string

  config object

  staging object

  stagingType integer

  serviceHost string

  cloudURL string

  stagingPath string

  stagingCredentials object

  credentialId integer

  credentialName string

  dataAccessNodes object

  dataAccessNodes object[]

  hostName string

  clientId integer

  clientName string

  displayName string

  selected boolean

  entity object

  clientName string

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object

  errorCode integer

  entity object

  clientId integer

  clientName string

  instanceId integer

  _type_ integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": {
    "errorCode": 0,
    "entity": {
      "clientId": 0,
      "clientName": "string",
      "instanceId": 0,
      "_type_": 0
    }
  }
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": {
    "errorCode": 0,
    "entity": {
      "clientId": 62,
      "clientName": "",
      "instanceId": 39,
      "_type_": 3
    }
  }
}

Bad Request

application/json

• Schema
• Example 1

---

Schema

• string

Request body is empty or format is invalid

Unauthorized

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Access Denied",
  "errorCode": 5
}

POST /client/yugabytedb    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

Body

• Default
• Example 1

---

{
  "createPseudoClientRequest": {
    "clientInfo": {
      "clientType": 0,
      "plan": {
        "planName": "string"
      },
      "subclientInfo": {
        "useLocalContent": true,
        "contentOperationType": 0,
        "content": [
          {
            "path": "string"
          }
        ]
      },
      "distributedClusterInstanceProperties": {
        "clusterType": 0,
        "opType": 0,
        "instance": {
          "instanceId": 0,
          "instanceName": "string",
          "clientName": "string",
          "applicationId": 64
        },
        "clusterConfig": {
          "yugabytedbConfig": {
            "dbHost": "string",
            "apiToken": "string",
            "customer": {
              "name": "string",
              "uuid": "string"
            },
            "universe": {
              "name": "string",
              "uuid": "string"
            },
            "customerConfig": {
              "name": "string",
              "uuid": "string"
            }
          },
          "config": {
            "staging": {
              "stagingType": 0,
              "serviceHost": "string",
              "cloudURL": "string",
              "stagingPath": "string",
              "stagingCredentials": {
                "credentialId": 0,
                "credentialName": "string"
              }
            }
          }
        },
        "dataAccessNodes": {
          "dataAccessNodes": [
            {
              "hostName": "string",
              "clientId": 0,
              "clientName": "string",
              "displayName": "string",
              "selected": true
            }
          ]
        }
      }
    },
    "entity": {
      "clientName": "string"
    }
  }
}

curl -L -X POST 'https://localhost/webconsole/api/Client/YugabyteDB' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "createPseudoClientRequest": {
    "clientInfo": {
      "clientType": 0,
      "plan": {
        "planName": "string"
      },
      "subclientInfo": {
        "useLocalContent": true,
        "contentOperationType": 0,
        "content": [
          {
            "path": "string"
          }
        ]
      },
      "distributedClusterInstanceProperties": {
        "clusterType": 0,
        "opType": 0,
        "instance": {
          "instanceId": 0,
          "instanceName": "string",
          "clientName": "string",
          "applicationId": 64
        },
        "clusterConfig": {
          "yugabytedbConfig": {
            "dbHost": "string",
            "apiToken": "string",
            "customer": {
              "name": "string",
              "uuid": "string"
            },
            "universe": {
              "name": "string",
              "uuid": "string"
            },
            "customerConfig": {
              "name": "string",
              "uuid": "string"
            }
          },
          "config": {
            "staging": {
              "stagingType": 0,
              "serviceHost": "string",
              "cloudURL": "string",
              "stagingPath": "string",
              "stagingCredentials": {
                "credentialId": 0,
                "credentialName": "string"
              }
            }
          }
        },
        "dataAccessNodes": {
          "dataAccessNodes": [
            {
              "hostName": "string",
              "clientId": 0,
              "clientName": "string",
              "displayName": "string",
              "selected": true
            }
          ]
        }
      }
    },
    "entity": {
      "clientName": "string"
    }
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/Client/YugabyteDB' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "createPseudoClientRequest": {
    "clientInfo": {
      "clientType": 0,
      "plan": {
        "planName": "string"
      },
      "subclientInfo": {
        "useLocalContent": true,
        "contentOperationType": 0,
        "content": [
          {
            "path": "string"
          }
        ]
      },
      "distributedClusterInstanceProperties": {
        "clusterType": 0,
        "opType": 0,
        "instance": {
          "instanceId": 0,
          "instanceName": "string",
          "clientName": "string",
          "applicationId": 64
        },
        "clusterConfig": {
          "yugabytedbConfig": {
            "dbHost": "string",
            "apiToken": "string",
            "customer": {
              "name": "string",
              "uuid": "string"
            },
            "universe": {
              "name": "string",
              "uuid": "string"
            },
            "customerConfig": {
              "name": "string",
              "uuid": "string"
            }
          },
          "config": {
            "staging": {
              "stagingType": 0,
              "serviceHost": "string",
              "cloudURL": "string",
              "stagingPath": "string",
              "stagingCredentials": {
                "credentialId": 0,
                "credentialName": "string"
              }
            }
          }
        },
        "dataAccessNodes": {
          "dataAccessNodes": [
            {
              "hostName": "string",
              "clientId": 0,
              "clientName": "string",
              "displayName": "string",
              "selected": true
            }
          ]
        }
      }
    },
    "entity": {
      "clientName": "string"
    }
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/Client/YugabyteDB' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "createPseudoClientRequest": {
    "clientInfo": {
      "clientType": 0,
      "plan": {
        "planName": "string"
      },
      "subclientInfo": {
        "useLocalContent": true,
        "contentOperationType": 0,
        "content": [
          {
            "path": "string"
          }
        ]
      },
      "distributedClusterInstanceProperties": {
        "clusterType": 0,
        "opType": 0,
        "instance": {
          "instanceId": 0,
          "instanceName": "string",
          "clientName": "string",
          "applicationId": 64
        },
        "clusterConfig": {
          "yugabytedbConfig": {
            "dbHost": "string",
            "apiToken": "string",
            "customer": {
              "name": "string",
              "uuid": "string"
            },
            "universe": {
              "name": "string",
              "uuid": "string"
            },
            "customerConfig": {
              "name": "string",
              "uuid": "string"
            }
          },
          "config": {
            "staging": {
              "stagingType": 0,
              "serviceHost": "string",
              "cloudURL": "string",
              "stagingPath": "string",
              "stagingCredentials": {
                "credentialId": 0,
                "credentialName": "string"
              }
            }
          }
        },
        "dataAccessNodes": {
          "dataAccessNodes": [
            {
              "hostName": "string",
              "clientId": 0,
              "clientName": "string",
              "displayName": "string",
              "selected": true
            }
          ]
        }
      }
    },
    "entity": {
      "clientName": "string"
    }
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/Client/YugabyteDB' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "createPseudoClientRequest": {
    "clientInfo": {
      "clientType": 0,
      "plan": {
        "planName": "string"
      },
      "subclientInfo": {
        "useLocalContent": true,
        "contentOperationType": 0,
        "content": [
          {
            "path": "string"
          }
        ]
      },
      "distributedClusterInstanceProperties": {
        "clusterType": 0,
        "opType": 0,
        "instance": {
          "instanceId": 0,
          "instanceName": "string",
          "clientName": "string",
          "applicationId": 64
        },
        "clusterConfig": {
          "yugabytedbConfig": {
            "dbHost": "string",
            "apiToken": "string",
            "customer": {
              "name": "string",
              "uuid": "string"
            },
            "universe": {
              "name": "string",
              "uuid": "string"
            },
            "customerConfig": {
              "name": "string",
              "uuid": "string"
            }
          },
          "config": {
            "staging": {
              "stagingType": 0,
              "serviceHost": "string",
              "cloudURL": "string",
              "stagingPath": "string",
              "stagingCredentials": {
                "credentialId": 0,
                "credentialName": "string"
              }
            }
          }
        },
        "dataAccessNodes": {
          "dataAccessNodes": [
            {
              "hostName": "string",
              "clientId": 0,
              "clientName": "string",
              "displayName": "string",
              "selected": true
            }
          ]
        }
      }
    },
    "entity": {
      "clientName": "string"
    }
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/Client/YugabyteDB' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "createPseudoClientRequest": {
    "clientInfo": {
      "clientType": 0,
      "plan": {
        "planName": "string"
      },
      "subclientInfo": {
        "useLocalContent": true,
        "contentOperationType": 0,
        "content": [
          {
            "path": "string"
          }
        ]
      },
      "distributedClusterInstanceProperties": {
        "clusterType": 0,
        "opType": 0,
        "instance": {
          "instanceId": 0,
          "instanceName": "string",
          "clientName": "string",
          "applicationId": 64
        },
        "clusterConfig": {
          "yugabytedbConfig": {
            "dbHost": "string",
            "apiToken": "string",
            "customer": {
              "name": "string",
              "uuid": "string"
            },
            "universe": {
              "name": "string",
              "uuid": "string"
            },
            "customerConfig": {
              "name": "string",
              "uuid": "string"
            }
          },
          "config": {
            "staging": {
              "stagingType": 0,
              "serviceHost": "string",
              "cloudURL": "string",
              "stagingPath": "string",
              "stagingCredentials": {
                "credentialId": 0,
                "credentialName": "string"
              }
            }
          }
        },
        "dataAccessNodes": {
          "dataAccessNodes": [
            {
              "hostName": "string",
              "clientId": 0,
              "clientName": "string",
              "displayName": "string",
              "selected": true
            }
          ]
        }
      }
    },
    "entity": {
      "clientName": "string"
    }
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/Client/YugabyteDB' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "createPseudoClientRequest": {
    "clientInfo": {
      "clientType": 0,
      "plan": {
        "planName": "string"
      },
      "subclientInfo": {
        "useLocalContent": true,
        "contentOperationType": 0,
        "content": [
          {
            "path": "string"
          }
        ]
      },
      "distributedClusterInstanceProperties": {
        "clusterType": 0,
        "opType": 0,
        "instance": {
          "instanceId": 0,
          "instanceName": "string",
          "clientName": "string",
          "applicationId": 64
        },
        "clusterConfig": {
          "yugabytedbConfig": {
            "dbHost": "string",
            "apiToken": "string",
            "customer": {
              "name": "string",
              "uuid": "string"
            },
            "universe": {
              "name": "string",
              "uuid": "string"
            },
            "customerConfig": {
              "name": "string",
              "uuid": "string"
            }
          },
          "config": {
            "staging": {
              "stagingType": 0,
              "serviceHost": "string",
              "cloudURL": "string",
              "stagingPath": "string",
              "stagingCredentials": {
                "credentialId": 0,
                "credentialName": "string"
              }
            }
          }
        },
        "dataAccessNodes": {
          "dataAccessNodes": [
            {
              "hostName": "string",
              "clientId": 0,
              "clientName": "string",
              "displayName": "string",
              "selected": true
            }
          ]
        }
      }
    },
    "entity": {
      "clientName": "string"
    }
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/Client/YugabyteDB' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "createPseudoClientRequest": {
    "clientInfo": {
      "clientType": 0,
      "plan": {
        "planName": "string"
      },
      "subclientInfo": {
        "useLocalContent": true,
        "contentOperationType": 0,
        "content": [
          {
            "path": "string"
          }
        ]
      },
      "distributedClusterInstanceProperties": {
        "clusterType": 0,
        "opType": 0,
        "instance": {
          "instanceId": 0,
          "instanceName": "string",
          "clientName": "string",
          "applicationId": 64
        },
        "clusterConfig": {
          "yugabytedbConfig": {
            "dbHost": "string",
            "apiToken": "string",
            "customer": {
              "name": "string",
              "uuid": "string"
            },
            "universe": {
              "name": "string",
              "uuid": "string"
            },
            "customerConfig": {
              "name": "string",
              "uuid": "string"
            }
          },
          "config": {
            "staging": {
              "stagingType": 0,
              "serviceHost": "string",
              "cloudURL": "string",
              "stagingPath": "string",
              "stagingCredentials": {
                "credentialId": 0,
                "credentialName": "string"
              }
            }
          }
        },
        "dataAccessNodes": {
          "dataAccessNodes": [
            {
              "hostName": "string",
              "clientId": 0,
              "clientName": "string",
              "displayName": "string",
              "selected": true
            }
          ]
        }
      }
    },
    "entity": {
      "clientName": "string"
    }
  }
}'