---
title: "Add new platform"
method: POST
path: "/private/platform"
tags: ["internal-platform"]
---

# Add new platform

`POST /private/platform`

Add new platform

## Request body

- AddPlatformRequest — Payload to define a platform
  - `platform_data` PlatformData, required — Information about YB Platform
    - `hostname` string
    - `cloud_info` CloudInfo — Cloud deployment information
      - `code` 'AWS' | 'GCP', required — Which cloud the cluster is deployed in
      - `region` string, required
    - `cidr` string — A CIDR block
    - `platform_type` 'Paid' | 'Free' | 'Both' — The type of clusters the platform supports
    - `vpc_id` string
    - `certificate_authority` string
    - `kube_cluster_endpoint` string
    - `kube_cluster_name` string
  - `credentials` string, required
  - `admin_api_key` string, uuid

## Response `200`

Platform response

- object
  - `data` PlatformDataResponse — Information about YB Platform
    - `id` string, uuid — The UUID of the platform
    - `platform_data` PlatformData — Information about YB Platform
      - `hostname` string
      - `cloud_info` CloudInfo — Cloud deployment information
        - `code` 'AWS' | 'GCP', required — Which cloud the cluster is deployed in
        - `region` string, required
      - `cidr` string — A CIDR block
      - `platform_type` 'Paid' | 'Free' | 'Both' — The type of clusters the platform supports
      - `vpc_id` string
      - `certificate_authority` string
      - `kube_cluster_endpoint` string
      - `kube_cluster_name` string
    - `num_clusters` integer

## Other responses

- `400` — API Error
- `500` — API Error

## Changes

- **2022-06-13** `7856cb3301b2` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/yugabyte/apis/yugabyte-cloud/changes/private/platform/post.md)

---

[API](https://skmtc.dev/yugabyte/apis/yugabyte-cloud.md) · [All operations](https://skmtc.dev/yugabyte/apis/yugabyte-cloud/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/yugabyte/yugabyte-cloud/revisions/7856cb3301b2/schema)