Edit branding settings

PUT /iam/reselling/settings

Edit branding settings

cURL

curl --request PUT \
  --url https://api.gcore.com/iam/reselling/settings \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "<string>",
  "publicSettings": {
    "showApiDoc": true,
    "showStatusPage": "<string>",
    "showKnowledgeBase": true,
    "showTickets": true,
    "brandName": "<string>",
    "fromEmail": "[e-mail]",
    "websiteLink": "<string>",
    "supportEmail": "<string>",
    "supportPhone": "<string>",
    "agreementLink": "<string>",
    "entryBaseDomain": "<string>",
    "colors": {
      "header": null,
      "primary": null
    }
  },
  "privateSettings": {
    "mailServer": {
      "tls": true,
      "host": "<string>",
      "port": "<string>",
      "login": "<string>",
      "password": "<string>"
    }
  }
}
'

import requests

url = "https://api.gcore.com/iam/reselling/settings"

payload = {
    "domain": "<string>",
    "publicSettings": {
        "showApiDoc": True,
        "showStatusPage": "<string>",
        "showKnowledgeBase": True,
        "showTickets": True,
        "brandName": "<string>",
        "fromEmail": "[e-mail]",
        "websiteLink": "<string>",
        "supportEmail": "<string>",
        "supportPhone": "<string>",
        "agreementLink": "<string>",
        "entryBaseDomain": "<string>",
        "colors": {
            "header": None,
            "primary": None
        }
    },
    "privateSettings": { "mailServer": {
            "tls": True,
            "host": "<string>",
            "port": "<string>",
            "login": "<string>",
            "password": "<string>"
        } }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    domain: '<string>',
    publicSettings: {
      showApiDoc: true,
      showStatusPage: '<string>',
      showKnowledgeBase: true,
      showTickets: true,
      brandName: '<string>',
      fromEmail: '[e-mail]',
      websiteLink: '<string>',
      supportEmail: '<string>',
      supportPhone: '<string>',
      agreementLink: '<string>',
      entryBaseDomain: '<string>',
      colors: {header: null, primary: null}
    },
    privateSettings: {
      mailServer: {
        tls: true,
        host: '<string>',
        port: '<string>',
        login: '<string>',
        password: '<string>'
      }
    }
  })
};

fetch('https://api.gcore.com/iam/reselling/settings', 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.gcore.com/iam/reselling/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'domain' => '<string>',
    'publicSettings' => [
        'showApiDoc' => true,
        'showStatusPage' => '<string>',
        'showKnowledgeBase' => true,
        'showTickets' => true,
        'brandName' => '<string>',
        'fromEmail' => '[e-mail]',
        'websiteLink' => '<string>',
        'supportEmail' => '<string>',
        'supportPhone' => '<string>',
        'agreementLink' => '<string>',
        'entryBaseDomain' => '<string>',
        'colors' => [
                'header' => null,
                'primary' => null
        ]
    ],
    'privateSettings' => [
        'mailServer' => [
                'tls' => true,
                'host' => '<string>',
                'port' => '<string>',
                'login' => '<string>',
                'password' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.gcore.com/iam/reselling/settings"

	payload := strings.NewReader("{\n  \"domain\": \"<string>\",\n  \"publicSettings\": {\n    \"showApiDoc\": true,\n    \"showStatusPage\": \"<string>\",\n    \"showKnowledgeBase\": true,\n    \"showTickets\": true,\n    \"brandName\": \"<string>\",\n    \"fromEmail\": \"[e-mail]\",\n    \"websiteLink\": \"<string>\",\n    \"supportEmail\": \"<string>\",\n    \"supportPhone\": \"<string>\",\n    \"agreementLink\": \"<string>\",\n    \"entryBaseDomain\": \"<string>\",\n    \"colors\": {\n      \"header\": null,\n      \"primary\": null\n    }\n  },\n  \"privateSettings\": {\n    \"mailServer\": {\n      \"tls\": true,\n      \"host\": \"<string>\",\n      \"port\": \"<string>\",\n      \"login\": \"<string>\",\n      \"password\": \"<string>\"\n    }\n  }\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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.put("https://api.gcore.com/iam/reselling/settings")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"<string>\",\n  \"publicSettings\": {\n    \"showApiDoc\": true,\n    \"showStatusPage\": \"<string>\",\n    \"showKnowledgeBase\": true,\n    \"showTickets\": true,\n    \"brandName\": \"<string>\",\n    \"fromEmail\": \"[e-mail]\",\n    \"websiteLink\": \"<string>\",\n    \"supportEmail\": \"<string>\",\n    \"supportPhone\": \"<string>\",\n    \"agreementLink\": \"<string>\",\n    \"entryBaseDomain\": \"<string>\",\n    \"colors\": {\n      \"header\": null,\n      \"primary\": null\n    }\n  },\n  \"privateSettings\": {\n    \"mailServer\": {\n      \"tls\": true,\n      \"host\": \"<string>\",\n      \"port\": \"<string>\",\n      \"login\": \"<string>\",\n      \"password\": \"<string>\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/iam/reselling/settings")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"<string>\",\n  \"publicSettings\": {\n    \"showApiDoc\": true,\n    \"showStatusPage\": \"<string>\",\n    \"showKnowledgeBase\": true,\n    \"showTickets\": true,\n    \"brandName\": \"<string>\",\n    \"fromEmail\": \"[e-mail]\",\n    \"websiteLink\": \"<string>\",\n    \"supportEmail\": \"<string>\",\n    \"supportPhone\": \"<string>\",\n    \"agreementLink\": \"<string>\",\n    \"entryBaseDomain\": \"<string>\",\n    \"colors\": {\n      \"header\": null,\n      \"primary\": null\n    }\n  },\n  \"privateSettings\": {\n    \"mailServer\": {\n      \"tls\": true,\n      \"host\": \"<string>\",\n      \"port\": \"<string>\",\n      \"login\": \"<string>\",\n      \"password\": \"<string>\"\n    }\n  }\n}"

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

200

{
  "domain": "<string>",
  "publicSettings": {
    "showApiDoc": true,
    "showStatusPage": "<string>",
    "showKnowledgeBase": true,
    "showTickets": true,
    "brandName": "<string>",
    "fromEmail": "[e-mail]",
    "websiteLink": "<string>",
    "supportEmail": "<string>",
    "supportPhone": "<string>",
    "agreementLink": "<string>",
    "entryBaseDomain": "<string>",
    "colors": {
      "header": null,
      "primary": null
    }
  },
  "privateSettings": {
    "mailServer": {
      "tls": true,
      "host": "<string>",
      "port": "<string>",
      "login": "<string>",
      "password": "<string>"
    }
  },
  "reseller": 123,
  "deleted": true
}

{
  "errors": {}
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Body

application/json

domain · string · required

Base control panel domain. The desired upper-level domain for the control panel. For example, if specified mycompany.com, then control panel will be available at auth.mycompany.com, cdn.mycompany.com, accounts.mycompany.com.

publicSettings · object · required

Show child attributes

privateSettings · object · required

Show child attributes

Response

200

application/json

OK.

domain · string · required

Base control panel domain. The desired upper-level domain for the control panel. For example, if specified mycompany.com, then control panel will be available at auth.mycompany.com, cdn.mycompany.com, accounts.mycompany.com.

publicSettings · object · required

Show child attributes

privateSettings · object · required

Show child attributes

reseller · integer · required · read-only

Reseller's ID.

deleted · boolean · required · read-only

Deletion flag. If true then entity was deleted.