Skip to main content
Version: v1.2.1

Update a third-party cluster

Update a third-party cluster

PUT 

https://api.cuemby.io/functions/v1/third-party-clusters/:thirdPartyClusterId

Update a third-party cluster

Request

Path Parameters

    thirdPartyClusterId stringrequired

    The ID of the third-party cluster to update

Header Parameters

    X-Organization-Id stringrequired

    The ID of the organization (this parameter is not required when using API key authorization)

    X-Project-Id stringrequired

    The ID of the project to update the runtime

Bodyrequired

    connectorIdstring
    Default value: string
    providerstring

    Possible values: [GCP, AWS, Azure]

    Default value: GCP
    clusterInfo object
    oneOf
    accessTypestringrequired

    Possible values: [INTERNAL, EXTERNAL]

    Default value: INTERNAL
    subnetworkstringrequired
    Default value: string
    machineTypestringrequired
    Default value: string
    diskSizestringrequired
    Default value: string
    preemptiblebooleanrequired
    Default value: false
    ipRangePodsstringrequired
    Default value: string
    ipRangeServicesstringrequired
    Default value: string
    initialNodeCountnumberrequired

    The number of nodes in the cluster (if have free tier in GCP, set to 1)

    Default value: 1

Responses

Success

Schema
    successboolean
    Default value: true
    timestampstring
    Default value: 2024-01-01T00:00:00.000Z
    statusCodenumber
    Default value: 200
    statusTextstring
    Default value: Success
    messagestring
    Default value: third-party cluster created
    localizationstring
    Default value: someone-method:success
    data object
    idstring
    Default value: string
    projectIdstring
    Default value: string
    namestring
    Default value: string
    providerstring
    Default value: GCP
    createdAtdate-time
    updatedAtdate-time

Authorization: x-api-key

name: x-api-keytype: apiKeyin: header
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://api.cuemby.io/functions/v1/third-party-clusters/:thirdPartyClusterId");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-key", "<x-api-key>");
var content = new StringContent("{\n \"connectorId\": \"string\",\n \"provider\": \"GCP\",\n \"clusterInfo\": {\n \"accessType\": \"INTERNAL\",\n \"subnetwork\": \"string\",\n \"machineType\": \"string\",\n \"diskSize\": \"string\",\n \"preemptible\": false,\n \"ipRangePods\": \"string\",\n \"ipRangeServices\": \"string\",\n \"initialNodeCount\": 1\n }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://api.cuemby.io/functions/v1
Auth
Parameters
— pathrequired
— headerrequired
— headerrequired
Body required
{
  "connectorId": "string",
  "provider": "GCP",
  "clusterInfo": {
    "accessType": "INTERNAL",
    "subnetwork": "string",
    "machineType": "string",
    "diskSize": "string",
    "preemptible": false,
    "ipRangePods": "string",
    "ipRangeServices": "string",
    "initialNodeCount": 1
  }
}
ResponseClear

Click the Send API Request button above and see the response here!