Skip to main content
Provision
curl --request POST \
  --url https://{api_endpoint}/v1/lite/provision \
  --header 'Content-Type: application/json' \
  --data '
{
  "serviceInstanceDisplayName": "<string>",
  "serviceInstanceNamespace": "<string>",
  "zenServiceInstanceInfo": {
    "zenCloudPakInstanceId": "<string>",
    "zenControlPlaneNamespace": "<string>",
    "zenImageRegistryPrefix": "<string>",
    "zenServiceInstanceId": "<string>",
    "zenServiceInstanceSecret": "<string>",
    "zenServiceInstanceType": "<string>",
    "zenServiceInstanceUID": "<string>",
    "zenServiceInstanceUserName": "<string>",
    "zenServiceInstanceVersion": "<string>"
  },
  "metadata": {},
  "parameters": {},
  "serviceInstanceDescription": ""
}
'
import requests

url = "https://{api_endpoint}/v1/lite/provision"

payload = {
"serviceInstanceDisplayName": "<string>",
"serviceInstanceNamespace": "<string>",
"zenServiceInstanceInfo": {
"zenCloudPakInstanceId": "<string>",
"zenControlPlaneNamespace": "<string>",
"zenImageRegistryPrefix": "<string>",
"zenServiceInstanceId": "<string>",
"zenServiceInstanceSecret": "<string>",
"zenServiceInstanceType": "<string>",
"zenServiceInstanceUID": "<string>",
"zenServiceInstanceUserName": "<string>",
"zenServiceInstanceVersion": "<string>"
},
"metadata": {},
"parameters": {},
"serviceInstanceDescription": ""
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
serviceInstanceDisplayName: '<string>',
serviceInstanceNamespace: '<string>',
zenServiceInstanceInfo: {
zenCloudPakInstanceId: '<string>',
zenControlPlaneNamespace: '<string>',
zenImageRegistryPrefix: '<string>',
zenServiceInstanceId: '<string>',
zenServiceInstanceSecret: '<string>',
zenServiceInstanceType: '<string>',
zenServiceInstanceUID: '<string>',
zenServiceInstanceUserName: '<string>',
zenServiceInstanceVersion: '<string>'
},
metadata: {},
parameters: {},
serviceInstanceDescription: ''
})
};

fetch('https://{api_endpoint}/v1/lite/provision', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://{api_endpoint}/v1/lite/provision",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'serviceInstanceDisplayName' => '<string>',
'serviceInstanceNamespace' => '<string>',
'zenServiceInstanceInfo' => [
'zenCloudPakInstanceId' => '<string>',
'zenControlPlaneNamespace' => '<string>',
'zenImageRegistryPrefix' => '<string>',
'zenServiceInstanceId' => '<string>',
'zenServiceInstanceSecret' => '<string>',
'zenServiceInstanceType' => '<string>',
'zenServiceInstanceUID' => '<string>',
'zenServiceInstanceUserName' => '<string>',
'zenServiceInstanceVersion' => '<string>'
],
'metadata' => [

],
'parameters' => [

],
'serviceInstanceDescription' => ''
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://{api_endpoint}/v1/lite/provision"

payload := strings.NewReader("{\n \"serviceInstanceDisplayName\": \"<string>\",\n \"serviceInstanceNamespace\": \"<string>\",\n \"zenServiceInstanceInfo\": {\n \"zenCloudPakInstanceId\": \"<string>\",\n \"zenControlPlaneNamespace\": \"<string>\",\n \"zenImageRegistryPrefix\": \"<string>\",\n \"zenServiceInstanceId\": \"<string>\",\n \"zenServiceInstanceSecret\": \"<string>\",\n \"zenServiceInstanceType\": \"<string>\",\n \"zenServiceInstanceUID\": \"<string>\",\n \"zenServiceInstanceUserName\": \"<string>\",\n \"zenServiceInstanceVersion\": \"<string>\"\n },\n \"metadata\": {},\n \"parameters\": {},\n \"serviceInstanceDescription\": \"\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://{api_endpoint}/v1/lite/provision")
.header("Content-Type", "application/json")
.body("{\n \"serviceInstanceDisplayName\": \"<string>\",\n \"serviceInstanceNamespace\": \"<string>\",\n \"zenServiceInstanceInfo\": {\n \"zenCloudPakInstanceId\": \"<string>\",\n \"zenControlPlaneNamespace\": \"<string>\",\n \"zenImageRegistryPrefix\": \"<string>\",\n \"zenServiceInstanceId\": \"<string>\",\n \"zenServiceInstanceSecret\": \"<string>\",\n \"zenServiceInstanceType\": \"<string>\",\n \"zenServiceInstanceUID\": \"<string>\",\n \"zenServiceInstanceUserName\": \"<string>\",\n \"zenServiceInstanceVersion\": \"<string>\"\n },\n \"metadata\": {},\n \"parameters\": {},\n \"serviceInstanceDescription\": \"\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{api_endpoint}/v1/lite/provision")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"serviceInstanceDisplayName\": \"<string>\",\n \"serviceInstanceNamespace\": \"<string>\",\n \"zenServiceInstanceInfo\": {\n \"zenCloudPakInstanceId\": \"<string>\",\n \"zenControlPlaneNamespace\": \"<string>\",\n \"zenImageRegistryPrefix\": \"<string>\",\n \"zenServiceInstanceId\": \"<string>\",\n \"zenServiceInstanceSecret\": \"<string>\",\n \"zenServiceInstanceType\": \"<string>\",\n \"zenServiceInstanceUID\": \"<string>\",\n \"zenServiceInstanceUserName\": \"<string>\",\n \"zenServiceInstanceVersion\": \"<string>\"\n },\n \"metadata\": {},\n \"parameters\": {},\n \"serviceInstanceDescription\": \"\"\n}"

response = http.request(request)
puts response.read_body
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Body

application/json
serviceInstanceDisplayName
string | null
required
serviceInstanceNamespace
string | null
required
zenServiceInstanceInfo
ZenServiceInstanceInfo · object | null
required
metadata
Metadata · object | null
parameters
Parameters · object | null
serviceInstanceDescription
string | null
default:""

Response

Successful Response