Create Instances Endpoint

curl --request POST \
  --url https://api.example.com/partner/instances/create \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'instance_type=<string>' \
  --data 'is_consulting=<string>' \
  --data 'parent_instance_id=<string>' \
  --data 'name=<string>' \
  --data 'short_name=<string>' \
  --data 'country=<string>' \
  --data 'email=<string>' \
  --data 'mfa_type=<string>' \
  --data 'tenant_id=<string>' \
  --data 'state=<string>' \
  --data 'city=<string>' \
  --data 'postal=<string>' \
  --data 'street=<string>'

import requests

url = "https://api.example.com/partner/instances/create"

payload = {
    "instance_type": "<string>",
    "is_consulting": "<string>",
    "parent_instance_id": "<string>",
    "name": "<string>",
    "short_name": "<string>",
    "country": "<string>",
    "email": "<string>",
    "mfa_type": "<string>",
    "tenant_id": "<string>",
    "state": "<string>",
    "city": "<string>",
    "postal": "<string>",
    "street": "<string>"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/x-www-form-urlencoded'},
  body: new URLSearchParams({
    instance_type: '<string>',
    is_consulting: '<string>',
    parent_instance_id: '<string>',
    name: '<string>',
    short_name: '<string>',
    country: '<string>',
    email: '<string>',
    mfa_type: '<string>',
    tenant_id: '<string>',
    state: '<string>',
    city: '<string>',
    postal: '<string>',
    street: '<string>'
  })
};

fetch('https://api.example.com/partner/instances/create', 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.example.com/partner/instances/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "instance_type=%3Cstring%3E&is_consulting=%3Cstring%3E&parent_instance_id=%3Cstring%3E&name=%3Cstring%3E&short_name=%3Cstring%3E&country=%3Cstring%3E&email=%3Cstring%3E&mfa_type=%3Cstring%3E&tenant_id=%3Cstring%3E&state=%3Cstring%3E&city=%3Cstring%3E&postal=%3Cstring%3E&street=%3Cstring%3E",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/x-www-form-urlencoded"
  ],
]);

$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.example.com/partner/instances/create"

	payload := strings.NewReader("instance_type=%3Cstring%3E&is_consulting=%3Cstring%3E&parent_instance_id=%3Cstring%3E&name=%3Cstring%3E&short_name=%3Cstring%3E&country=%3Cstring%3E&email=%3Cstring%3E&mfa_type=%3Cstring%3E&tenant_id=%3Cstring%3E&state=%3Cstring%3E&city=%3Cstring%3E&postal=%3Cstring%3E&street=%3Cstring%3E")

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

	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

	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.example.com/partner/instances/create")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .body("instance_type=%3Cstring%3E&is_consulting=%3Cstring%3E&parent_instance_id=%3Cstring%3E&name=%3Cstring%3E&short_name=%3Cstring%3E&country=%3Cstring%3E&email=%3Cstring%3E&mfa_type=%3Cstring%3E&tenant_id=%3Cstring%3E&state=%3Cstring%3E&city=%3Cstring%3E&postal=%3Cstring%3E&street=%3Cstring%3E")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/partner/instances/create")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "instance_type=%3Cstring%3E&is_consulting=%3Cstring%3E&parent_instance_id=%3Cstring%3E&name=%3Cstring%3E&short_name=%3Cstring%3E&country=%3Cstring%3E&email=%3Cstring%3E&mfa_type=%3Cstring%3E&tenant_id=%3Cstring%3E&state=%3Cstring%3E&city=%3Cstring%3E&postal=%3Cstring%3E&street=%3Cstring%3E"

response = http.request(request)
puts response.read_body

{
  "instance_id": "<string>",
  "agent_key": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

Instances

Create Instances Endpoint

This endpoint will provision a new instance under your partner account.

It is important to understand the hierarchy of the organizations set up under the CYRISMA Web platform. Instances can be created under existing organizations or sub organizations, or new sub organizations can be created.

Notes:

Generation of an instance generally takes less than 5 minutes to complete.
Check the completion of your order by using the provision-status API call along with the returned instance ID provided.
Parent_instance_id is the immediate parent where this new instance or sub-organization will appear in the hierarchy.
If setting up a new sub-organization, the is_consulting value must be false. You cannot create a sub-organization that is considered “Trial” or “Consulting”.
If setting up a new instance, then is_consulting may be set to true to indicate that this instance is in a temporary consulting mode and will eventually be converted to “standard”.
The short_name is the name value that appears at the top left of the browser window when logged into that instance. It is also the name of the browser tab, so it is recommended to keep this string relatively short to serve as a quick identifier when you have many tabs open.
Country value is very important as it will determine the geographic location where this specific instance will be located. Many organizations are subject to data sovereignty restrictions that mandate all data stay within a specific geography and this setting will assist.
Mfa_type defaults to 0 (none), but can be set to 1 (Email) or 2 (Authenticator) when submitting the new provisioning request.
Tenant_id is an optional string parameter to associate this provisioning with a pre-existing tenant of an MDR/XDR suite.

Required headers:

Authorization: access_token {token}

POST

partner

instances

create

Create Instances Endpoint

curl --request POST \
  --url https://api.example.com/partner/instances/create \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'instance_type=<string>' \
  --data 'is_consulting=<string>' \
  --data 'parent_instance_id=<string>' \
  --data 'name=<string>' \
  --data 'short_name=<string>' \
  --data 'country=<string>' \
  --data 'email=<string>' \
  --data 'mfa_type=<string>' \
  --data 'tenant_id=<string>' \
  --data 'state=<string>' \
  --data 'city=<string>' \
  --data 'postal=<string>' \
  --data 'street=<string>'

import requests

url = "https://api.example.com/partner/instances/create"

payload = {
    "instance_type": "<string>",
    "is_consulting": "<string>",
    "parent_instance_id": "<string>",
    "name": "<string>",
    "short_name": "<string>",
    "country": "<string>",
    "email": "<string>",
    "mfa_type": "<string>",
    "tenant_id": "<string>",
    "state": "<string>",
    "city": "<string>",
    "postal": "<string>",
    "street": "<string>"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/x-www-form-urlencoded'},
  body: new URLSearchParams({
    instance_type: '<string>',
    is_consulting: '<string>',
    parent_instance_id: '<string>',
    name: '<string>',
    short_name: '<string>',
    country: '<string>',
    email: '<string>',
    mfa_type: '<string>',
    tenant_id: '<string>',
    state: '<string>',
    city: '<string>',
    postal: '<string>',
    street: '<string>'
  })
};

fetch('https://api.example.com/partner/instances/create', 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.example.com/partner/instances/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "instance_type=%3Cstring%3E&is_consulting=%3Cstring%3E&parent_instance_id=%3Cstring%3E&name=%3Cstring%3E&short_name=%3Cstring%3E&country=%3Cstring%3E&email=%3Cstring%3E&mfa_type=%3Cstring%3E&tenant_id=%3Cstring%3E&state=%3Cstring%3E&city=%3Cstring%3E&postal=%3Cstring%3E&street=%3Cstring%3E",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/x-www-form-urlencoded"
  ],
]);

$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.example.com/partner/instances/create"

	payload := strings.NewReader("instance_type=%3Cstring%3E&is_consulting=%3Cstring%3E&parent_instance_id=%3Cstring%3E&name=%3Cstring%3E&short_name=%3Cstring%3E&country=%3Cstring%3E&email=%3Cstring%3E&mfa_type=%3Cstring%3E&tenant_id=%3Cstring%3E&state=%3Cstring%3E&city=%3Cstring%3E&postal=%3Cstring%3E&street=%3Cstring%3E")

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

	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

	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.example.com/partner/instances/create")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .body("instance_type=%3Cstring%3E&is_consulting=%3Cstring%3E&parent_instance_id=%3Cstring%3E&name=%3Cstring%3E&short_name=%3Cstring%3E&country=%3Cstring%3E&email=%3Cstring%3E&mfa_type=%3Cstring%3E&tenant_id=%3Cstring%3E&state=%3Cstring%3E&city=%3Cstring%3E&postal=%3Cstring%3E&street=%3Cstring%3E")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/partner/instances/create")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "instance_type=%3Cstring%3E&is_consulting=%3Cstring%3E&parent_instance_id=%3Cstring%3E&name=%3Cstring%3E&short_name=%3Cstring%3E&country=%3Cstring%3E&email=%3Cstring%3E&mfa_type=%3Cstring%3E&tenant_id=%3Cstring%3E&state=%3Cstring%3E&city=%3Cstring%3E&postal=%3Cstring%3E&street=%3Cstring%3E"

response = http.request(request)
puts response.read_body

{
  "instance_id": "<string>",
  "agent_key": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

Headers

Authorization

string

Body

application/x-www-form-urlencoded

Request data for creating a new instance.

instance_type

string

required

Type of the instance to be created.

Minimum string length: 1

is_consulting

string

required

Indicates if the instance is for consulting.

Minimum string length: 1

parent_instance_id

string

required

ID of the parent instance.

Minimum string length: 1

name

string

required

Name of the instance.

Minimum string length: 1

short_name

string

required

Short name of the instance.

Minimum string length: 1

country

string

required

Country of the instance.

Minimum string length: 1

string

required

Email associated with the instance.

Minimum string length: 1

mfa_type

string | null

Type of multi-factor authentication.

tenant_id

string | null

Tenant ID of the instance.

state

string | null

Phone number associated with the instance.

city

string | null

City of the instance.

postal

string | null

Postal code of the instance.

street

string | null

Street address of the instance.

Response

Represents the JSON structure for creating a new instance.

instance_id

string | null

The unique identifier for the created instance.

agent_key

string | null

The agent key associated with the created instance.

Create Instance User Endpoint Suspend Instance Endpoint

Overview

Dashboards

Instances

Login

Scans

Users

Vulnerability Assets

Create Instances Endpoint

Headers

Body

Response