Data Payload

This is an information message

Please Note:

This part of the documentation is under construction and will continuously be extended. Not all available day 2 actions are currently documented.

General

POST

Advanced Reconfigure

Advanced Reconfigure: Service Levels and Storage Policies

Important 1: For this API call to succeed, the VM needs to be powered off.

Important 2: This action lets you configure (1) the service level and datacenter location and (2) the disk's storage policies. Even if only the datacenter location value needs to be changed, all current targetDisk values still have to be submitted via this API call. Also, if only the disk policies need to be changed, the current location still has to be submitted via this API call. Otherwise the call will fail.

Important 3: Make sure that you only set a datacenter location that fits the selected serviceLevel, see here for more details.

Parameter	Type	Required	Possible Values
__businessGroup	string	true
locationLocation of the datacenter. Even if just the disk policies need to be changed, the location value is still required.	string	true
locationConstraintDatacenter Location Constraint. Constraints will not enforce the VM to always run at the selected location. If the location is down, the VM will be started on a different cluster to ensure business continuity.	string	if `serviceLevel == 'Advanced'`
serviceLevel	string	false	See List Basic Standard Advanced
targetPolicyDisk0For each existing disk, the policy value is required. If a disk's policy should not be changed, the old policy value has to be submitted nevertheless.	string	if `existingDisks.length >= 1`	See List Economy-SRev Fast-SRev Ultrafast-SRev
targetPolicyDisk1For each existing disk, the policy value is required. If a disk's policy should not be changed, the old policy value has to be submitted nevertheless.	string	if `existingDisks.length >= 2`	See List Economy-SRev Fast-SRev Ultrafast-SRev
targetPolicyDisk2For each existing disk, the policy value is required. If a disk's policy should not be changed, the old policy value has to be submitted nevertheless.	string	if `existingDisks.length >= 3`	See List Economy-SRev Fast-SRev Ultrafast-SRev
targetPolicyDisk3For each existing disk, the policy value is required. If a disk's policy should not be changed, the old policy value has to be submitted nevertheless.	string	if `existingDisks.length >= 4`	See List Economy-SRev Fast-SRev Ultrafast-SRev
targetPolicyDisk4For each existing disk, the policy value is required. If a disk's policy should not be changed, the old policy value has to be submitted nevertheless.	string	if `existingDisks.length >= 5`	See List Economy-SRev Fast-SRev Ultrafast-SRev
targetPolicyDisk5For each existing disk, the policy value is required. If a disk's policy should not be changed, the old policy value has to be submitted nevertheless.	string	if `existingDisks.length >= 6`	See List Economy-SRev Fast-SRev Ultrafast-SRev
targetPolicyDisk6For each existing disk, the policy value is required. If a disk's policy should not be changed, the old policy value has to be submitted nevertheless.	string	if `existingDisks.length >= 7`	See List Economy-SRev Fast-SRev Ultrafast-SRev
targetPolicyDisk7For each existing disk, the policy value is required. If a disk's policy should not be changed, the old policy value has to be submitted nevertheless.	string	if `existingDisks.length >= 8`	See List Economy-SRev Fast-SRev Ultrafast-SRev
targetPolicyDisk8For each existing disk, the policy value is required. If a disk's policy should not be changed, the old policy value has to be submitted nevertheless.	string	if `existingDisks.length >= 9`	See List Economy-SRev Fast-SRev Ultrafast-SRev
targetPolicyDisk9For each existing disk, the policy value is required. If a disk's policy should not be changed, the old policy value has to be submitted nevertheless.	string	if `existingDisks.length >= 10`	See List Economy-SRev Fast-SRev Ultrafast-SRev
tenantName	string	true

Example Data Payload:

{
  "__businessGroup": "businessgroup005",
  "location": "Olten - Gold Datacenter",
  "locationConstraint": "VM_WL-Str-Prd-01_Should_SRV_OLT",
  "serviceLevel": "Advanced",
  "targetPolicyDisk0": "Economy-SRev",
  "targetPolicyDisk1": "Economy-SRev",
  "targetPolicyDisk2": "Economy-SRev",
  "targetPolicyDisk3": "Economy-SRev",
  "targetPolicyDisk4": "Economy-SRev",
  "targetPolicyDisk5": "Economy-SRev",
  "targetPolicyDisk6": "Economy-SRev",
  "targetPolicyDisk7": "Economy-SRev",
  "targetPolicyDisk8": "Economy-SRev",
  "targetPolicyDisk9": "Economy-SRev",
  "tenantName": "tenant-005"
}

POST

Reconfigure

Reconfigure a machine.

Important: For this API call to succeed, the VM needs to be in Customer Maintenance or Temp Admin mode.

Make sure to request the template for this action to receive all current configurations. Only change the needed configurations and submit all existing configurations together with your changes.

The existing configurations for customProperties, disks and nics need to be submitted in any case. For example: If you change only the description and set customProperties to [] or null, all custom properties would be deleted.

Warning: Make sure to always submit the existing configurations together with your changes, never submit only your changes.

Important: You cannot create Disks or Nics with this action, you can only change their properties.

Parameter	Type	Required	Possible Values
allowForceShutdownPower off the machine, if machine shutdown fails during reconfigure. (Careful: A boolean value, but as string.)	string	false	See List 'false' 'true'
cpuNumber of CPUs (Select 2-32)	number	false
customPropertiesReconfigure custom properties.	customProperty[]	true
descriptionDescription of the machine.	string	false
disksReconfigure Storage volumes.	disk[]	true
executionSelector	string	false
memoryIn MB, between 8192-1048576.	number	false
nicsReconfigure Network adapters	nic[]	true
powerActionSelectorSpecifies whether to reboot a machine if required (default), prevent a machine reboot, or reboot a machine regardless of whether it is required. A machine reboot is required before reconfiguration if you make a CPU or memory change and hot CPU/memory add is not enabled or has been disabled by a custom property. A machine is not rebooted if it is in the Shutdown state.	string	false
requestor	string	false

Example Data Payload:

{
  "allowForceShutdown": "false",
  "cpu": 2,
  "customProperties": [
    "<--customPropertyObjectsFromActionTemplate-->"
  ],
  "description": "This is a Swisscom machine.",
  "disks": [
    "<--diskObjectsFromActionTemplate-->"
  ],
  "executionSelector": "1",
  "memory": 8192,
  "nics": [
    "<--nicObjectsFromActionTemplate-->"
  ],
  "powerActionSelector": "0",
  "requestor": "APIUser"
}

POST

Show and Update Technical Contact

Shows the existing Technical Contact Data of a VM, allows to change this Contact Data

Parameter	Type	Required	Possible Values
technicalContactEmailPlease enter a new valid Technical Contact Emailaddress. Groupmailbox preferred.	string	true	Regex ^[A-Za-z0-9.!#$%&'*+-/=?^_`{|}~]+[@]([a-z0-9]+[.])+[a-z]+$ No Match
technicalContactPhonePlease enter a new Technical Contact Phone. Allowed characters: +, space, 0-9	string	true	Regex /^[+]{0,1}[0-9 ]+$/ No Match

Example Data Payload:

{
  "technicalContactEmail": "test@swisscom.com",
  "technicalContactPhone": "0800 800 800"
}

File Service Premium

File Service Instance

POST

Add NFS Container Premium

Adds a container of the premium product-model. Relevant for the billed price is the pre-allocated storage size, independent of the effectively used amount.

Parameter	Type	Required	Possible Values
backup_policyDefines the retention time of backups for this container.	string	true	See List none backup_30 backup_90 backup_365
instanceNameFriendly name of the container	string	true
performanceClassThe selected performance class is applied to all shares created under this container.	string	true	See List eco fast ultrafast
protectionDefines the service class for this container. Service level Standard is equal to single-site storage. Service level Advanced is multi-site storage.	string	true	See List single_site dual_site

Example Data Payload:

{
  "backup_policy": "none",
  "instanceName": "NfsTestContainer",
  "performanceClass": "eco",
  "protection": "single_site"
}

POST

Add SMB Container Premium

Adds a container of the premium product-model. Relevant for the billed price is the pre-allocated storage size, independent of the effectively used amount.

Parameter	Type	Required	Possible Values
p_backup_policyDefines the retention time of backups for this container.	string	true	See List none backup_30 backup_90 backup_365
p_friendly_nameFriendly name of the container	string	true
p_performance_classThe selected performance class is applied to all shares created under this container.	string	true	See List eco fast ultrafast
p_protectionDefines the service class for this container. Service level Standard is equal to single-site storage. Service level Advanced is multi-site storage.	string	true	See List single_site dual_site

Example Data Payload:

{
  "p_backup_policy": "none",
  "p_friendly_name": "SmbTestContainer",
  "p_performance_class": "eco",
  "p_protection": "single_site"
}

POST

Add iSCSI Container

Creates a iSCSI Container for the File System Service.

Parameter	Type	Required	Possible Values
backupPolicyDefines the retention time of backups for this container	string	true	See List none backup_30 backup_90 backup_365
instanceNameFriendly name of the container.	string	true
performanceClassThe selected performance class is applied to all shares created under this container.	string	true	See List eco fast ultrafast
protectionDefines the service class for this container. Service level Standard is equal to single-site storage. Service level Advanced is multi-site storage.	string	true	See List single_site dual_site

Example Data Payload:

{
  "backupPolicy": "none",
  "instanceName": "my container",
  "performanceClass": "eco",
  "protection": "single_site"
}

POST

Add iSCSI Initiator Group

Creates a iSCSI Initiator Group for the File System Service.

Parameter	Type	Required	Possible Values
instanceNameName of the Initiator Group. Format: Name of the Initiator Group. Format: Between 2 and 50 alphanumeric characters. First character must be a letter. The only special characters allowed are underline (_) and dash (-). No whitespaces are allowed. The name must be unique per file service instance. The name is not case sensitive e.g. instances with names "test" and "Test" are not possible at the same time.	string	true	Regex /^[a-zA-Z]{1}[0-9a-zA-Z_-]{1,49}$/ No Match
operatingSystemThe operating system the Initiator Group is optimized for.	string	true	See List linux windows

Example Data Payload:

{
  "instanceName": "initiatorGroup1",
  "operatingSystem": "linux"
}

POST

Delete File Service

Deletes the File Service.

Parameter	Type	Required	Possible Values
confirmconfirm	boolean	true	Fixed Valuetrue

Example Data Payload:

{
  "confirm": true
}

POST

Edit File Service

Edit Name, DNS Servers, DNS Domain Name and nfsv4 Domain Name

Parameter	Type	Required	Possible Values
instanceNameFriendly name for this File Service. With this name, the instance can be identified on the bill.	string
dnsServerDefine the nameservers which are used to resolve hostnames. Multiple servers can be separated by a colon. e.g: "192.168.1.1, 192.168.10.1, 192.168.100.50	string	If dnsDomainName != null
dnsDomainNameDefines the default domain to be used for DNS resolution. e.g "storage.local"	string	If dnsServer != null
nfsv4DomainNameSets the NFSv4 domain name to be used. In many cases, this is equal to the DNS domain.	string	false

Example Data Payload:

{
  "instanceName": "TestFileService",
  "dnsServer": "192.168.1.1, 192.168.10.1, 192.168.100.50",
  "dnsDomainName": "storage.local",
  "nfsv4DomainName": "storage.local"
}

iSCSI Initiator Group

POST

Add iSCSI Initiator

Creates a iSCSI Initiator for the iSCSI Initiator Group.

Parameter	Type	Required	Possible Values
instanceNameFriendly name of the initiator.	string	true
initiatorThe initiator identifies a client and is used to map permissions to access a LUN. Format: IQN or EUI; Examples: "iqn.1990-02.ch.swisscom:test" or "eui.0123456789ABCDEF". The name must be unique per file service instance. The name is not case sensitive e.g. instances with names "test" and "Test" are not possible at the same time.	string	true	Regex /^(?=.{15,223}$)iqn\.\d{4}-\d{2}(?:\.[A-Za-z](?:[A-Za-z0-9\-]*[A-Za-z0-9])?)+(?::.([^,:\s']+))?$|^eui\.[0-9A-Fa-f]{16}$/ No Match

Example Data Payload:

{
  "instanceName": "myInitiator",
  "initiator": "iqn.2020-04.sample"
}

POST

Delete iSCSI Initiator Group

Delete iSCSI Initiator Group

Parameter	Type	Required	Possible Values
confirmConfirm the deletion. Please note: All child elements must be deleted first.	boolean	true	Fixed Valuetrue

Example Data Payload:

{
  "confirm": true
}

iSCSI Initiator

POST

Delete iSCSI Initiator

Delete iSCSI Initiator

Parameter	Type	Required	Possible Values
confirmconfirm	boolean	true	Fixed Valuetrue

Example Data Payload:

{
  "confirm": true
}

INFO

Get Credentials

This action cannot be submitted. It is used to read values via the GUI. If you want to read the form values of this action, you have to use the forms API.

Payload for /forms/request/update:

{
  "affectedElements": [
    "provider-initiatorUsername",
    "provider-initiatorPassword",
    "provider-targetUsername",
    "provider-targetPassword"
  ]
}

iSCSI Container

POST

Add iSCSI LUN

Creates a iSCSI LUN for the iSCSI Container.

Parameter	Type	Required	Possible Values
lunNameName of the LUN. Format: Between 2 and 16 alphanumeric characters. First character must be a letter. The only special characters allowed are underline (_) and dash (-). No whitespaces are allowed. The name must be unique per container instance. The name is not case sensitive e.g. instances with names "test" and "Test" are not possible at the same time.	string	true	Regex /^[a-zA-Z]{1}[0-9a-zA-Z_-]{1,15}$/ No Match
lunIdOptional ID of the LUN. Number between 0-255	int	false
sizeGibAllocated size for this share in GiB. Values: 1 - 16384	int	true
intiatorGroupCombination of Initiator Group name and id in the format "name (id)"	string	true

Example Data Payload:

{
  "lunName": "testLun-1",
  "lunId": "10",
  "sizeGib": "4",
  "intiatorGroup": "initiatorgroup (ad3774e9-ae21-4cb2-a0fd-fe7e1378e18d)"
}

POST

Edit iSCSI Container

Edit iSCSI Container.

Parameter	Type	Required	Possible Values
instanceNameFriendly name of the container.	string	true
performanceClassThe selected performance class is applied to all shares created under this container.	string	true	See List eco fast ultrafast
backupPolicyDefines the retention time of backups for this container.	string	true	See List none backup_30 backup_90 backup_365

Example Data Payload:

{
  "instanceName": "my container",
  "performanceClass": "eco",
  "backupPolicy": "none"
}

POST

Delete iSCSI Container

Delete iSCSI Container

Parameter	Type	Required	Possible Values
confirmConfirm the deletion. Please note: All child elements must be deleted first.	boolean	true	Fixed Valuetrue

Example Data Payload:

{
  "confirm": true
}

iSCSI LUN

POST

Edit iSCSI LUN

Edit the iSCSI LUN of the iSCSI Container.

Parameter	Type	Required	Possible Values
sizeGibAllocated size for this share in GiB. Values: 1 - 16384. It is not allowed to shrink a lun.	int	true

Example Data Payload:

{
  "sizeGib": "4"
}

POST

Delete iSCSI LUN

Delete iSCSI LUN

Parameter	Type	Required	Possible Values
confirmconfirm	boolean	true	Fixed Valuetrue

Example Data Payload:

{
  "confirm": true
}

NFS Container Premium

POST

Edit NFS Container Premium

Edits a container of the premium product-model. Relevant for the billed price is the pre-allocated storage size, independent of the effectively used amount.

Parameter	Type	Required	Possible Values
instanceNameName of the NFS container.	string	true
performanceClassThe selected performance class is applied to all shares created under this container.	string	true	See List eco fast ultrafast
backupPolicyDefines the retention time of backups for this container.	string	true	See List none backup_30 backup_90 backup_365

Example Data Payload:

{
  "instanceName": "newcontainer",
  "performanceClass": "eco",
  "backupPolicy": "none"
}

POST

Delete NFS Container Premium

Deletes the NFS dedicated container.

Parameter	Type	Required	Possible Values
confirmConfirm deletion of the whole container, all shares underneath must be previously deleted as well. Deletion is only possible, if the backup policy was previously set to "None" (this deletes all existing backups).	boolean	true	Fixed Valuetrue

Example Data Payload:

{
  "confirm": true
}

POST

Add NFS Share Premium

Creates a new NFS share / export. Mounting permissions can be defined in a granular way. In the premium model, the shares have a predefined size.

Parameter	Type	Required	Possible Values
allowedAccessListAllowed access list (single IP address, IP ranges in CIDR notation, hostname), plus a permission indicator ("~rw" for read-writable, "~ro" for read-only, "~rsro" for read-only root squash, "~rsrw" read-write root squash, "~alls" all squash, "~alrs" root squash all). For multiple ACLs add one entry per line or separated by ",".	string	true
shareNameThe name of the share. This will be added as a suffix to the mountpoint. Format: Between 2 and 16 alphanumeric characters. First character must be a letter. The only special characters allowed are underline (_) and dash (-). No whitespaces are allowed. The name must be unique per container instance. The name is not case sensitive e.g. instances with names "test" and "Test" are not possible at the same time.	string	true	Regex /^[a-zA-Z]{1}[0-9a-zA-Z_-]{1,15}$/ No Match
sizeGibAllocated size for this share in GiB. Values: 1 - 81920	integer	true

Example Data Payload:

{
  "allowedAccessList": "vm.storage.local~rw,10.144.20.156~rsrw,10.144.20.248~alls,10.144.20.248~alrs",
  "shareName": "NfsTestShare",
  "sizeGib": 2
}

NFS Share Premium

POST

Edit NFS Share Premium

Modifies the NFS share / export.

Parameter	Type	Required	Possible Values
allowedAccessListAllowed access list (single IP address, IP ranges in CIDR notation, hostname), plus a permission indicator ("~rw" for read-writable, "~ro" for read-only, "~rsro" for read-only root squash, "~rsrw" read-write root squash, "~alls" all squash, "~alrs" root squash all). For multiple ACLs add one entry per line or separated by ",".	string	true
sizeGibAllocated size for this share in GiB. Values: 1 - 81920. The new size can not be less than the used storage.	number	true

Example Data Payload:

{
  "allowedAccessList": "vm.storage.local~rw,10.144.20.156~rsrw,10.144.20.248~alls,10.144.20.248~alrs",
  "sizeGib": 3
}

POST

Delete NFS Share Premium

Deletes the NFS dedicated export

Parameter	Type	Required	Possible Values
confirmConfirm that the share gets deleted. The existing backups on the container remain until expiration as defined in the backup policy.	boolean	true

Example Data Payload:

{
  "confirm": true
}

SMB Container Premium

POST

Edit SMB Container Premium

Edits a container of the premium product-model. Relevant for the billed price is the pre-allocated storage size, independent of the effectively used amount.

Parameter	Type	Required	Possible Values
instanceNameName of the NFS container.	string	true
performanceClassThe selected performance class is applied to all shares created under this container.	string	true	See List eco fast ultrafast
backupPolicyDefines the retention time of backups for this container.	string	true	See List none backup_30 backup_90 backup_365

Example Data Payload:

{
  "instanceName": "DnsTestContainer",
  "performanceClass": "eco",
  "backupPolicy": "none"
}

POST

Delete SMB Container Premium

Deletes the SMB dedicated container.

Parameter	Type	Required	Possible Values
confirmConfirm that the container gets deleted. The existing backups on the container remain until expiration as defined in the backup policy	boolean	true

Example Data Payload:

{
  "confirm": true
}

POST

Add SMB Share Premium

Creates a new SMB share / export. Mounting permissions can be defined in a granular way. In the premium model, the shares have a predefined size.

Parameter	Type	Required	Possible Values
shareNameName of the Share. Format: Between 3 and 16 alphanumeric characters. Allowed special characters are: underline (_), dash ( - ) and dollar sign ($). Additional rules apply: The first character needs to be alphabetic. A dollar sign can only be put at the end of the share name. This will create a hidden share. The name must be unique per file service instance. The name is not case sensitive e.g. instances with names "test" and "Test" are not possible at the same time.	string	true	Regex /^[a-zA-Z][0-9a-zA-Z_-]{2,15}$|^[a-zA-Z][0-9a-zA-Z_-]{2,14}\$$/ No Match
sizeGibSize of the share (1-81920 GiB)	number	true
antiVirusScanEnableEnable AntiVirus	boolean	true
encryptionEnabledEnable SMB encryption for data transfer over SMB. By default set to TRUE. Please be aware changing the encryption configuration might trigger disruptions.	boolean	true

Example Data Payload:

{
  "shareName": "ShareTestName",
  "sizeGib": 2,
  "antiVirusScanEnable": false,
  "encryptionEnabled": true
}

SMB Share Premium

POST

Edit SMB Share Premium

Modifies the SMB share / export.

Parameter	Type	Required	Possible Values
sizeGibAllocated size for this share in GiB. Values: 1 - 81920. The new size can not be less than the used storage.	number	true
antiVirusScanEnableEnable AntiVirus	boolean	true
encryptionEnabledEnable SMB encryption for data transfer over SMB. Please be aware changing the encryption configuration might trigger disruptions.	boolean	true

Example Data Payload:

{
  "sizeGib": 3,
  "antiVirusScanEnable": false,
  "encryptionEnabled": true
}

POST

Delete SMB Share Premium

Deletes the SMB dedicated share

Parameter	Type	Required	Possible Values
confirmConfirm that the share gets deleted. The existing backups on the container remain until expiration as defined in the backup policy.	boolean	true

Example Data Payload:

{
  "confirm": true
}

Kubernetes

Kubernetes Environment

POST

Create Cluster

Parameter	Type	Required	Possible Values
parentRefName of the Kubernetes Environment	string	true
planNamePlan	string	true	See List basic advanced
hostnameCluster External Hostname. Max lenght: 63 characters.	string	true
workerNodePoolsWorker Node Pools	array	true	See List { "name": "Only dashes and [0-9A-Za-z],max 12 digits", "cpu": [ 1, 2, 4, 8, 16, 32, 64 ], "memory_gb": [ 4, 8, 16, 32, 64, 128, 256, 512 ], "persistent_disk_gb": [ "min 32gb - max 500gb" ], "count": "No limit yet", "node_labels": "Max 2 labels allowed, separated by ',' ", "node_taints": "Max 2 taints allowed, seperated by ',' effect has to be one of these 'NoSchedule, PreferNoSchedule, NoExecute' " }
lbSizeLoad Balancer Size	string	true	See List medium large
insecureRegistriesProvide a comma separated list of insecure registries. E.g. insecure.dontdo.that, insecure.onlyfor.dev	string	false

Example Data Payload:

{
  "parentRef": "Kubernetes Environment - 22e7f853-2242-4858-8ba4-c5a222a04e96",
  "planName": "basic",
  "hostname": "test.test.com",
  "workerNodePools": [
    {
      "name": "profile-1",
      "cpu": 2,
      "memory_gb": 8,
      "persistent_disk_gb": 32,
      "count": 3,
      "node_labels": "team=red,billing=yes",
      "node_taints": "taint=test:PreferNoSchedule,taint=prd:NoExecute"
    }
  ],
  "lbSize": "medium",
  "insecureRegistries": "insecure.dontdo.that, insecure.onlyfor.dev"
}

POST

Delete Environment

Parameter	Type	Required	Possible Values
confirmConfirm Delete	boolean	true	Fixed Valuetrue

Example Data Payload:

{
  "confirm": true
}

INFO

Show IP Allocations

This action does not work via API call since it shows the IP allocations only when opening the action form - and not when submitting the POST request. This action is available from v135.

Kubernetes Cluster

POST

Add Persistent Storage

Parameter	Type	Required	Possible Values
datastoreCountDefines the amount of additional storage units. Each additional storage unit adds additional 8TB of capacity to your cluster. By default, there is already a 1 TB unit attached. One extension can cover up to 5 x 8 TB. If more storage is needed a second order musst be placed.	number	true

Example Data Payload:

{
  "datastoreCount": 1
}

INFO

Create Credentials

This action cannot be submitted. It is used to read values via the GUI. If you want to read the form values of this action, you have to use the forms API.

Payload for /forms/request/update:

{
  "affectedElements": ["provider-credentials"]
}

POST

Delete Cluster

Parameter	Type	Required	Possible Values
confirmConfirm deletion of Cluster	boolean	true	Fixed Valuetrue

Example Data Payload:

{
  "confirm": true
}

POST

Edit Cluster

Parameter	Type	Required	Possible Values
workerNodePoolsWorker Node Pools	array	true	See List { "name": "Only dashes and [0-9A-Za-z],max 12 digits", "cpu": [ 1, 2, 4, 8, 16, 32, 64 ], "memory_gb": [ 4, 8, 16, 32, 64, 128, 256, 512 ], "persistent_disk_gb": [ "min 32gb - max 500gb" ], "count": "No limit yet" }
insecureRegistriesInsecure Registries	string	true
customerFwActiveDefines if the Customer Firewall is enabled or disaabled	boolean	true
customerFwRulesDefinition of the Customer Firewall Rules. Rules must be in JSON Notation with the following format: [{"name": "Rule1", "ip_range": "10.0.0.0/16", "protocol": "any"}]	string	if customerFwActive === true
idpActiveOIDC Enabled?	boolean	false
idpClientIdOIDC Client ID	string	if idpActive == true
idpIssuerUrlOIDC Issuer URL	string	if idpActive == true
idpUsernameClaimODIC Username Claim	string	if idpActive == true
idpCaFileOIDC CA File (Base64 Encoded)	string	if idpActive == true

Example Data Payload:

{
  "workerNodePools": [
    {
      "name": "profile-1",
      "cpu": 2,
      "memory_gb": 8,
      "persistent_disk_gb": 32,
      "count": 3
    }
  ],
  "insecureRegistries": "None",
  "customerFwActive": true,
  "customerFwRules": "[{\"name\": \"Rule1\", \"ip_range\": \"10.0.0.0/16\", \"protocol\": \"any\"}]"
}

POST

Initiate Cluster Upgrade

No parameters needed, empty data payload is sufficient.

Example Data Payload:

{}

Managed MS SQL

POST

Add Database to Availability Group

An existing DB can be added to an existing availability group. If the host currently running the database ist not the primary node of the target availability group, the availability group will be moved.

Parameter	Type	Required	Possible Values
ag	string	true
database	string	true

Example Data Payload:

{
  "ag": "AG-L01",
  "database": "myDatabase"
}

POST

Clone MS SQL Database

Generates a schema-only clone of a database.

Parameter	Type	Required	Possible Values
DatabaseNameThe database to be copied.	string	true

Example Data Payload:

{
  "DatabaseName": "Database1"
}

POST

Create MS SQL Database

Parameter	Type	Required	Possible Values
DataGrowth	decimal	true
DataInitSize	decimal	true
DataMaxSize	decimal	true
DatabaseName	string	true	Regex /^(?:[A-Za-z_][\\w@$#_]{0,120})$/ No Match
LogGrowth	decimal	true
LogInitSize	decimal	true
LogMaxSize	decimal	true
LoginPwFor secure passwords follow these guidelines: at least 8 characters long; does not contain the user name or parts of the user's full name; use at least three of the four available character types: lowercase letters, uppercase letters, numbers, and symbols	string	true
LoginPwRepeat	string	if unmanaged
vmPassword	string	if unmanaged
vmUsername	string	if unmanaged

Example Data Payload:

{
  "DataGrowth": 200,
  "DataInitSize": 1000,
  "DataMaxSize": 2000,
  "DatabaseName": "myDatabase",
  "LogGrowth": 200,
  "LogInitSize": 200,
  "LogMaxSize": 400,
  "LoginPw": "aBcDeFgHi123",
  "LoginPwRepeat": "aBcDeFgHi123",
  "vmPassword": "myVmPassword123",
  "vmUsername": "myVmUser"
}

POST

Delete MS SQL Database

Parameter	Type	Required	Possible Values
DatabaseName	string	true
vmPassword	string	if unmanaged
vmUsername	string	if unmanaged

Example Data Payload:

{
  "DatabaseName": "myDatabase",
  "vmPassword": "myVmPassword123",
  "vmUsername": "myVmUser"
}

POST

Export MS SQL Database

Export for Microsoft SQL Server databases using full backup files (.bak files) and stored on your S3 bucket.

Parameter	Type	Required	Possible Values
managedNeeds to be true if VM is managed.	boolean	If VM is a managed VM.
vmUsernameVM Username	string	if unmanaged
vmPasswordVM Password	string	if unmanaged
databaseNameThe name of the database to back up	string	true
accessKeyIdS3 Access Key	string	true
secretAccessKeyS3 Secret Access Key	string	true
exportPathThe bucket to use for the backup	string	true

Example Data Payload:

{
  "managed": true,
  "vmUsername": "myVmUser",
  "vmPassword": "myVmPassword123",
  "databaseName": "myDatabase",
  "accessKeyId": "",
  "secretAccessKey": "",
  "exportPath": "mybucketname/myfilename"
}

POST

Import MS SQL Database

Import for Microsoft SQL Server databases using full backup files (.bak files) stored on your S3 bucket.

Parameter	Type	Required	Possible Values
accessKeyIdS3 Access Key	string	true
secretAccessKeyS3 Secret Access Key	string	true
restoreFromThe S3 bucket that contains the backup file, and the name of the file (e.g. transfer_bucket/db_dump.bak)	string	true	Regex /(.*\/)*.+\.(bak|BAK)$/ No Match
databaseNameThe name of the database to restore	string	true
loginPwLogin Password	string	true
loginPwRepeatConfirm Login Password	string	true

Example Data Payload:

{
  "accessKeyId": "",
  "secretAccessKey": "",
  "restoreFrom": "transfer_bucket/db_dump.bak",
  "databaseName": "myDatabase",
  "loginPw": "aBcDeFgHi123",
  "loginPwRepeat": "aBcDeFgHi123"
}

POST

Manage Agent Based Backup

Update Ahead

Used to change Agent Based Backup Policy. If there was no Policy set, it will install and activate Agent Based Backup.

Parameter	Type	Required	Possible Values
newPolicy	string	true	See List None P01-FullDaily-TLog15Minutes-Retention90D P02-FullDaily-TLog60Minutes-Retention90D P03-FullWeekly-TLog60Minutes-Retention90D P04-FullDaily-TLog15Minutes-Retention30D P05-FullWeekly-TLog60Minutes-Retention30D P06-FullWeekly-TLog60Minutes-Retention08D P07-No-UserDB-Backup

Example Data Payload:

{
  "newPolicy": "P01-FullDaily-TLog15Minutes-Retention90D"
}

POST

Mass Migrate MS SQL Databases

An user can use Mass Migrate MS SQL Databases feature to move multiple or very large databases to Swisscom's Enterprise Service Cloud Services.

Parameter	Type	Required	Possible Values
accessKeyIdS3 Access Key	string	true
secretAccessKeyS3 Secret Access Key	string	true
restoreFromThe S3 bucket and folder with the backups to be restored (e.g. transfer/SQLVM01).	string	true	Regex /^[^\/].*\/.*/ No Match
actionType	string	true	See List Recovery No Recovery
databaseName"All" to restore all databases.	string	true
loginPwFor secure passwords follow these guidelines: at least 8 characters long; use at least three of the four available character types: lowercase letters, uppercase letters, numbers, and symbols	string	true
loginPwRepeat	string	true

Example Data Payload:

{
  "accessKeyId": "",
  "secretAccessKey": "",
  "restoreFrom": "myBucket/myFolder",
  "actionType": "Recovery",
  "databaseName": "All",
  "loginPw": "some$password123",
  "loginPwRepeat": "some$password123"
}

POST

Move Availability Group

An availability group can be moved from one node to the other.

Parameter	Type	Required	Possible Values
ag	string	true

Example Data Payload:

{
  "ag": "AG-L01"
}

POST

Remove Database from Availability Group

A DB can be removed from an availability group. The DB will be then removed on the replica, but not from the primary.

Parameter	Type	Required	Possible Values
database	string	true

Example Data Payload:

{
  "database": "myDatabase"
}

POST

Run On Demand SQL Backup

Update Ahead

Parameter	Type	Required	Possible Values
backupAllDatabases	boolean	If 'databaseNames' is not set.
backupType	string	true	See List Full Diff TXNLog
compressionType	string	true	See List Networker SQL
databaseNames	string[]	If 'backupAllDatabases' is false
managedCurrently, this day-2 action is only supported in full-managed mode. Therefore, managed shall be set to true and the vmUsername and vmPassword are not needed.	boolean	true
tenant	string	true
useEncryption	boolean	false
vmPasswordCurrently, this day-2 action is only supported in full-managed mode. Therefore, managed shall be set to true and the vmUsername and vmPassword are not needed.	string	If 'managed' is false
vmUsernameCurrently, this day-2 action is only supported in full-managed mode. Therefore, managed shall be set to true and the vmUsername and vmPassword are not needed.	string	If 'managed' is false

Example Data Payload:

{
  "backupAllDatabases": false,
  "backupType": "Full",
  "compressionType": "Networker",
  "databaseNames": [
    "Database1"
  ],
  "managed": true,
  "tenant": "yourtenant-005",
  "useEncryption": false
}

POST

Run On Demand SQL Restore

Update Ahead

Parameter	Type	Required	Possible Values
businessGroupId	string	true
databaseName	string	true
managedFor Managed SQL this needs to be true	boolean	true
manualInput	boolean	If 'timeFromList' is undefined
tenant	string	true
timeThe chosen date and time will be in local time zone (browser based). ISO8601 date/time string. Example: 2020-04-25T16:30:00.000+0200	string	If 'manualInput' is true
timeFromListExisting backup time as a string like so: 'Thu Apr 23 2020 15:09:49 GMT-0000 (UTC)'	string	If 'manualInput' is false
vmPassword	string	If 'managed' is false
vmUsername	string	If 'managed' is false

Example Data Payload:

{
  "businessGroupId": "businessGroup005",
  "databaseName": "database001",
  "managed": true,
  "manualInput": true,
  "tenant": "tenant-005",
  "time": "2020-04-25T16:30:00.000+0200",
  "timeFromList": "Thu Apr 23 2020 15:09:49 GMT-0000 (UTC)"
}

POST

Reconfigure Always On Disk

Reconfigure Always On Disk must be run on both nodes seperatliy, with the same values.

Parameter	Type	Required	Possible Values
diskIndexIndex of the Disk to reconfigure, example of 1 would be D: drive.	number	true	See List 1 2 3 4
diskSizeDisk size must be provided in GB and bigger then the previous disk size.	number	true

Example Data Payload:

{
  "diskIndex": "0",
  "diskSize": "50"
}

POST

Set MS SQL Monitoring

Using this second day action "Set MS SQL Monitoring" the user is able to enable Telegraf monitoring agent with custom defined parameters. This can be used to set alerting or visualization dashboards in a SQL Instance.

Parameter	Type	Required	Possible Values
Provider Name	string	true
Telegraf Configuration	string	true

Example Data Payload:

{
  "Provider Name": "Telegraf",
  "Telegraf Configuration": "Check README in Technical Description \"Monitoring Microsoft SQL Server\""
}

POST

Run SQL Migration Wizard

Parameter	Type	Required	Possible Values
blueprintNameName of the target blueprint	string	true	See List Managed MS SQL DBMS 2019 Managed MS SQL Always On 2019 Managed MS SQL DBMS DBA Mode 2019
targetTarget vm for the sql migration	string	true
confirmDepending on whether certain customer property fields are true, it is necessary to send confirm true with the request.	boolean	false	See List true false

Example Data Payload:

{
  "blueprintName": "Managed MS SQL DBMS 2019",
  "target": "YourVmName",
  "confirm": "true"
}

POST

Upload files to MS SQL

Transfer files from a S3 bucket to a local directory on the MS SQL Server. By doing this, you can use these files with SQL Server features such as BULK INSERT. Consult the documentation for supported file extensions.

Parameter	Type	Required	Possible Values
overwriteExistingFilesRemoves all files which are currently in the import directory	boolean	true
uploadFromDefines a bucket and folder name on the configured S3 namespace from which the import will be executed. Format: bucket/folder (case sensitive)	string	true	Regex /^[^\/].*\/.*/ No Match
accessKeyIdS3 Access Key	string	true
secretAccessKeyS3 Secret Access Key	string	true

Example Data Payload:

{
  "overwriteExistingFiles": true,
  "uploadFrom": "myBucket/myFolder",
  "accessKeyId": "",
  "secretAccessKey": ""
}

POST

Update MS SQL Permissions

Manage permissions on a SQL Server in addition to the pre-installed stored procedures.

Parameter	Type	Required	Possible Values
actionType"createCustomerAdmin" Create a new SQL login member of the customerAdmin role "createWindowsCustomerAdmin Create a new Windows login member of the customerAdmin role "grantBulkAdmin" Grant membership to the bulkadmin server role to an existing login "grantCustomerAdmin" Add an existing login to customerAdmin server role "grantSetupAdmin" Grant membership to the setupadmin server role to an existing login "grantSQLAgentUserRole" Grant membership to the SqlAgentUserRole der msdb "revokeCustomerAdmin" Revoke membership from customerAdmin server role "revokeBulkAdmin" Revoke membership from bulkadmin server role "revokeSetupAdmin" Revoke membership from setupadmin server role "revokeSQLAgentUserRole" Revoke membership of the SqlAgentUserRole der msdb	string	true	See List createCustomerAdmin createWindowsCustomerAdmin grantBulkAdmin grantCustomerAdmin grantSetupAdmin grantSQLAgentUserRole grantViewServerState revokeViewServerState revokeBulkAdmin revokeCustomerAdmin revokeSetupAdmin revokeSQLAgentUserRole
loginName	string	true
loginPwFor secure passwords follow these guidelines: at least 8 characters long; does not contain the user name or parts of the user's full name; use at least three of the four available character types: lowercase letters, uppercase letters, numbers, and symbols	string	If actionType is ‘createCustomerAdmin’
loginPwRepeat	string	If 'loginPw' is not 'null'

Example Data Payload:

{
  "actionType": "createCustomerAdmin",
  "loginName": "usernameAbc",
  "loginPw": "Password$123",
  "loginPwRepeat": "Password$123"
}

POST

Install MS SQL Cumulative Update

2nd day action that is applicable to 2017 and 2019 MS SQL managed instances for installation of cumulative update

Parameter	Type	Required	Possible Values
CUList	string	true

Example Data Payload:

{
  "CUList": "P00_ALL_SWP_sqlserver2017-SQL Server 2017 RTM Cumulative Update (CU) 30 KB5013756"
}

Managed Oracle Database (Regular)

CDB Actions

Actions to be executed on a CDB instance.

POST

Create PDB

Parameter	Type	Required	Possible Values
p_enable_oracle_text_option	boolean	true
p_friendly_name	string	true
p_operation_support_type	string	true	See List office hours 7x24h
p_pdb_character_set_type	string	true	See List AL32UTF8 WE8ISO8859P1 WE8ISO8859P15 WE8MSWIN1252
p_pdb_lockdown_profile_type	string	true	See List Default Java Next Generation Legacy Restricted Default MODS Highend
p_pdb_service_nameThe PDB Service Name specifies the service name (with or without domain). If the domain is not specified, the standard domain "vmmgmnt.trivadis.com" will be added by default. Example Service Name (with domain): "pdbcrm01.appsrv.com". The PDB Service Name must be unique within the CDB. Format: Between 2 and 64 characters (alphanumerics and "_", "-" and ".").	string	true	Regex /^[a-zA-Z0-9-._]{0,64}$/ Match!
planName	string	true	See List EE Default SE2 Default
p_pdb_security_shape_typeSecurity shapes revoke a set of package permissions (e.g. UTL_SMTP, UTL_TCP, etc.) from PUBLIC schema in Oracle that can be an issue from security point of view	string	true
__osbServiceName	string	true	See List MODS Regular PDB (EE) MODS Regular PDB (SE)

Example Data Payload:

{
  "p_enable_oracle_text_option": false,
  "p_friendly_name": "TestPDB",
  "p_operation_support_type": "office hours",
  "p_pdb_character_set_type": "AL32UTF8",
  "p_pdb_lockdown_profile_type": "Default",
  "p_pdb_service_name": "host1.example.com",
  "planName": "EE Default",
  "p_pdb_security_shape_type": "sc_cis_recommendations",
  "__osbServiceName": "MODS Regular PDB (EE)"
}

POST

Delete CDB

Parameter	Type	Required	Possible Values
confirmConfirm Deletion	boolean	true	Fixed Valuetrue

Example Data Payload:

{
  "confirm": true
}

POST

Edit CDB

Parameter	Type	Required	Possible Values
serviceName	string	true	See List MODS Regular CDB (EE)
planName	string	true	See List EE Basic EE Advanced
p_plan_mode	string	if 'Advanced'	See List SYNC_FSFO SYNC_NOFSFO ASYNC
p_friendly_name	string	true
p_vm_cpu_countAmount of vCPUs	decimal	true
p_enabled_backup_configuration	boolean	true

Example Data Payload:

{
  "serviceName": "MODS Regular CDB (EE)",
  "planName": "EE Advanced",
  "p_plan_mode": "SYNC_FSFO",
  "p_friendly_name": "TestFriendlyName",
  "p_vm_cpu_count": 4,
  "p_enabled_backup_configuration": false
}

POST

Set CID Status

Parameter	Type	Required	Possible Values
p_confirmI have read and understood this information	boolean	true

Example Data Payload:

{
  "p_confirm": true
}

POST

Upgrade CDB

Parameter	Type	Required	Possible Values
oracle_db_version_typeOracle Version	string	true

Example Data Payload:

{
  "oracle_db_version_type": "19.16.0"
}

Create CDB can be found under catalog requests.

PDB Actions

Actions to be executed on a PDB instance.

POST

Activate encryption

No parameters needed, empty data payload is sufficient.

Example Data Payload:

{}

POST

Delete PDB

Parameter	Type	Required	Possible Values
confirmConfirm Deletion	boolean	true	Fixed Valuetrue

Example Data Payload:

{
  "confirm": true
}

POST

Edit PDB

Parameter	Type	Required	Possible Values
p_friendly_nameFriendly Name	string	true
p_pdb_lockdown_profile_typeLockdown Profile	string	true	See List Default Java Next Generation Legacy Restricted Default MODS Highend
p_operation_support_typeDetermines the period in which the PDB is monitored and when incidents to this PDB are worked on	string	true	See List office hours 7x24h
p_pdb_security_shape_typeSecurity shapes revoke a set of package permissions (e.g. UTL_SMTP, UTL_TCP, etc.) from PUBLIC schema in Oracle that can be an issue from security point of view	string	true
p_enable_oracle_text_optionEnable Oracle Text Option. Cannot be switched back from true to false.	boolean	true

Example Data Payload:

{
  "p_friendly_name": "TestPDB",
  "p_pdb_lockdown_profile_type": "Default",
  "p_operation_support_type": "office hours",
  "p_pdb_security_shape_type": "sc_cis_recommendations",
  "p_enable_oracle_text_option": false
}

POST

Clone PDB

For more details about the cloning feature please use the "User Guide" for "Clone Pluggable Database PDB"

Parameter	Type	Required	Possible Values
__cdbIdThe Service ID of the CDB Parent Instance.	string	true
p_pdb_clone_typeDefines the clone type for the cloned PDB. FULL: The cloned PDB is a 1:1 copy of the source PDB and independent from the source PDB once the clone operation is completed. 1:1 means same content as the source and same size (storage). SNAPSHOT: The cloned PDB is based on a snapshot from its source PDB and remains therefore dependent on the source PDB. This means it has initially the same content but not the size. The clone size grows with the data changes. All unchanged data in the clone refers to the source PDB. Therefore the source cannot be deleted as long as any related snapshot PDB does exist. IMPORTANT: The source PDB is opened read only as soon as the first snapshot is created and reverted back to read write when the last snapshot is deleted. RESTORE: The source PDB is restored to a point-in-time from the past into a new PDB. It has the same size and it is completely independent from the source PDB. As target the new PDB can be located in the same or another CDB. The source CDB must have backup enabled.	string	true	See List snapshot full restore
pdb_clone_timestampClone the PDB to the given timestamp. Timestamp must not point to the future and must not be older than 11 days. Format: YYYY-MM-DD hh:mm:ss. Please specify the timestamp in UTC.	string	true	Regex /^([2][0][1|2][0-9])-(([0][1-9])|([1][0-2]))-(([0][1-9])|([1-2][0-9])|([3][0-1])) (([0-1][0-9])|([2][0-3])):([0-5][0-9]):([0-5][0-9])$/ No Match
target_cdb_instance_idTarget CDB Id - Only required for clone type "restore". Choose the CDB where the new PDB must be restored. It can be the same or another CDB. Target CDB must be the same edition and must be part of the same Business Group as the source CDB.	string	true
p_enable_pdb_replicationDefines if the PDB is replicated to the standby - Only required for the clone type FULL and RESTORE if the target PDB belongs to an ADVANCED CDB. Once enabled the cloned PDB will be available on the standby database as well.	boolean	true	See List true false
p_pdb_service_nameThe PDB Service Name specifies the service name (with or without domain). If the domain is not specified, the standard domain "vmmgmnt.trivadis.com" will be added by default. Example Service Name (with domain): "pdbcrm01.appsrv.com". The PDB Service Name must be unique within the CDB. Format: Between 2 and 64 characters (alphanumerics and "_", "-" and ".").	string	true	Regex /^[a-zA-Z0-9-._]{0,64}$/ Match!
p_friendly_nameCan be an arbitrary name for the instance, which must not be unique.	string	true
p_operation_support_typeDetermines the period in which the PDB is monitored and when incidents to this PDB are worked on.	string	true
p_pdb_lockdown_profile_typeDefines the lockdown profile which should be used for the PDB.	string	true	See List Default Java Next Generation Legacy Restricted Default MODS Highend
p_pdb_security_shape_typeAvailable Security Shapes: sc_cis_recommendations implement CIS specific security measures sc_sec_best_practice implement Swisscom / Trivadis specific security measures sc_ora_default standard Oracle security measures e.g. standard Oracle installation	string	true
planNameDepending on lincense type of CDB	string	true	See List EE Default Clone SE2 Default Clone
p_pdb_character_set_typeDefines the Character Set definition for a PDB.	string	true
p_enable_oracle_text_optionIf this option is selected, the Oracle Text option will be installed within the database.	boolean	true
__osbPdbServiceName	string	true	See List MODS Regular PDB (EE) MODS Regular PDB (SE)

Example Data Payload:

{
  "__cdbId": "3a183496-7454-4f3f-8e2e-aca30eb28124",
  "p_pdb_clone_type": "restore",
  "pdb_clone_timestamp": "2021-12-03 10:15:30",
  "target_cdb_instance_id": "58b22aae-35f7-4da4-b131-03162d039264",
  "p_enable_pdb_replication": "true",
  "p_pdb_service_name": "myPdbClone",
  "p_friendly_name": "myPdbClone",
  "p_operation_support_type": "office hours",
  "p_pdb_lockdown_profile_type": "Default",
  "p_pdb_security_shape_type": "sc_cis_recommendations",
  "planName": "EE Default Clone",
  "p_pdb_character_set_type": "AL32UTF8",
  "p_enable_oracle_text_option": "false",
  "__osbPdbServiceName": "MODS Regular PDB (EE)"
}

POST

Get Credentials

No parameters needed, empty data payload is sufficient.

Example Data Payload:

{}

POST

Mount NFS Share

Parameter	Type	Required	Possible Values
p_nfs_uriNFS Share URI	string	true

Example Data Payload:

{
  "p_nfs_uri": "192.168.101.4:/aa12_a939_0002/NFSShareTest"
}

POST

Restart PDB

No parameters needed, empty data payload is sufficient.

Example Data Payload:

{}

POST

Restore PDB

The PDB can be restored to any time within the retention time. Timestamp must not point to the future and must not be older than 11 days

Parameter	Type	Required	Possible Values
pdbPitrTimestampThe PDB can be restored to any time within the retention time. Currently, the retention is 11 days. Format: YYYY-MM-DD hh:mm:ss. Please specify the timestamp in UTC.	string	true	Regex /^([2][0][1|2][0-9])-(([0][1-9])|([1][0-2]))-(([0][1-9])|([1-2][0-9])|([3][0-1])) (([0-1][0-9])|([2][0-3])):([0-5][0-9]):([0-5][0-9])$/ No Match

Example Data Payload:

{
  "pdbPitrTimestamp": "2022-01-03 10:15:30"
}

Credentials Actions

Actions to be executed on a Managed Oracle Database PDB Credentials object.

POST

Delete Credentials

No parameters needed, empty data payload is sufficient.

Example Data Payload:

{}

Managed Oracle Database (Highend)

PDB Actions

Actions to be executed on a PDB instance.

POST

Clone PDB

Enables to clone a PDB from source into a destination on the same or a different (restore clone) CDB

Parameter	Type	Required	Possible Values
pdb_clone_typeDefines the clone type for the cloned PDB. - FULL: The cloned PDB is a 1:1 copy of the source PDB and independent from the source PDB once the clone operation is completed. 1:1 means same content as the source and same size (storage). - SNAPSHOT: The cloned PDB is based on a snapshot from its source PDB and remains therefore dependent on the source PDB. This means it has initially the same content but not the size. The clone size grows with the data changes. All unchanged data in the clone refers to the source PDB. Therefore the source cannot be deleted as long as any related snapshot PDB does exist. (IMPORTANT: The source PDB is opened read only as soon as the first snapshot is created and reverted back to read write when the last snapshot is deleted.) - RESTORE: The source PDB is restored to a point-in-time from the past into a new PDB. It has the same size and it is completely independent from the source PDB. As target the new PDB can be located in the same or another CDB. The source CDB must have backup enabled.	string	true	See List snapshot full restore
pdb_clone_timestampPDB Clone Timestamp (YYYY-MM-DD hh:mm:ss). Clone the PDB to the given timestamp. Timestamp must not point to the future and must not be older than 11 days. Please specify the timestamp in UTC.	string	false	Regex /^([2][0][1|2][0-9])-(([0][1-9])|([1][0-2]))-(([0][1-9])|([1-2][0-9])|([3][0-1])) (([0-1][0-9])|([2][0-3])):([0-5][0-9]):([0-5][0-9])$/ No Match
target_cdb_for_pdb_clone_nameChoose the CDB where the new PDB must be restored. It can be the same or another CDB. Target CDB must be the same edition and must be part of the same Business Group as the source CDB.	string	true
enable_pdb_replicationPDB Replication	boolean	false
friendly_nameFriendly Name	string	true
operation_support_typeSupport hours	string	true	See List office hours 7x24h
resource_prioritizationResource Prioritization	string	true	See List low medium high
pdb_lockdown_profile_typeDefines the lockdown profile which should be used for the PDB.	string	true	See List Default Java Next Generation Legacy Restricted Default MODS Regular
pdb_security_shape_typeSecurity Shape	string	true	See List sc_ora_default sc_cis_recommendations sc_sec_best_practices

Example Data Payload:

{
  "pdb_clone_type": "restore",
  "pdb_clone_timestamp": "2022-01-05 10:20:00",
  "target_cdb_for_pdb_clone_name": null,
  "enable_pdb_replication": true,
  "friendly_name": null,
  "operation_support_type": "office hours",
  "resource_prioritization": "low",
  "pdb_lockdown_profile_type": "Default",
  "pdb_security_shape_type": "sc_ora_default"
}

POST

Get Credentials

No parameters needed, empty data payload is sufficient.

Example Data Payload:

{}

POST

Mount NFS Share

Parameter	Type	Required	Possible Values
p_nfs_uriNFS URI	string	true

Example Data Payload:

{
  "p_nfs_uri": "192.168.101.4:/aa12_a939_0002/NFSShareTest"
}

POST

Restart PDB

No parameters needed, empty data payload is sufficient.

Example Data Payload:

{}

POST

Start PDB

No parameters needed, empty data payload is sufficient.

Example Data Payload:

{}

POST

Stop PDB

No parameters needed, empty data payload is sufficient.

Example Data Payload:

{}

POST

Delete PDB

Parameter	Type	Required	Possible Values
confirm	boolean	true

Example Data Payload:

{
  "confirm": true
}

POST

Edit PDB

Parameter	Type	Required	Possible Values
resource_prioritization	string	true	See List low medium high
enable_tablespace_encryption	boolean	false
operation_support_type	string	true	See List 7x24h office hours
pdb_lockdown_profile_typeDefines the lockdown profile which should be used for the PDB.	string	true	See List Default Java Next Generation Legacy Restricted Default MODS Regular
pdb_security_shape_type	string	true	See List sc_ora_default sc_cis_recommendations sc_sec_best_practices

Example Data Payload:

{
  "resource_prioritization": "medium",
  "enable_tablespace_encryption": true,
  "operation_support_type": "7x24h",
  "pdb_lockdown_profile_type": "Default",
  "pdb_security_shape_type": "sc_ora_default"
}

POST

Restore PDB

Restore a PDB from a specific restore point

Parameter	Type	Required	Possible Values
pdbPitrTimestampRestore Point (YYYY-MM-DD hh:mm:ss). The PDB can be restored to any time within the retention time. Currently, the retention is 11 days. Please specify the timestamp in UTC.	string	true	Regex /^([2][0][1|2][0-9])-(([0][1-9])|([1][0-2]))-(([0][1-9])|([1-2][0-9])|([3][0-1])) (([0-1][0-9])|([2][0-3])):([0-5][0-9]):([0-5][0-9])$/ No Match

Example Data Payload:

{
  "pdbPitrTimestamp": "2022-01-05 10:20:00"
}

Managed Oracle PDB (Highend) can be found under catalog requests.

Credentials Actions

Actions to be executed on a Managed Oracle Database Highend PDB Credentials instance.

POST

Delete Credentials

No parameters needed, empty data payload is sufficient.

Example Data Payload:

{}

Managed PostgreSQL

Container Actions

Actions to be executed on a MPDS Container instance.

POST

Add Instance

Adds a Managed PostgreSQL Instance to an existing Managed PostgreSQL Container.

Parameter	Type	Required	Possible Values
friendly_nameFriendly name for this PostgreSQL Instance. With this name, the corresponding instance is visible on the bill and consumption report. Format: Characters, numbers, underscore "_" and dash "-")	string	true
replication_modeDefines the Standby protection mode for the ADVANCED plan. ASYNC mode is the default and uses asynchronous network transport without automatic failover. SYNC_MANUAL mode enables synchronous network transport without automatic failover in case the Master instance crashes. SYNC_AUTO mode enables synchronous network transport between the Master and the Standby database including automatic failover in case the Master instance crashes.	string	true	See List ASYNC SYNC_AUTO SYNC_MANUAL
pg_version_typeSpecifies the major PostgreSQL version for the Instance.	string	true	See List 13 14
operation_support_typeDetermines the period in which the Instance is monitored and when incidents are worked on.	string	true	See List office hours 24x7h
ssl_transportDefines if secure SSL connections from client to server are enforced (required) or not (optional).	string	true	See List required optional
enable_backup_configurationIf this option is selected, an Instance backup will be set up with point in time restore capabilities. Choosing this option causes additional costs. The amount of storage used on the backup system is charged in GB.	boolean	false
backup_retentionBackup retention (days). Define how long backups must be stored for this Instance.	string	true	See List 3 11 30 90
enable_backup_encryptionIf this option is selected the backup files are encrypted. Choosing this option can cause higher CPU load during the backup operation. Disabling/Enabling this option at a later point (Edit Instance) will make existing backups unaccessible and the retention starts from zero. The operation deletes existing backups and creates a new full backup.	boolean	false

Example Data Payload:

{
  "friendly_name": "mysql-instance",
  "replication_mode": "ASYNC",
  "pg_version_type": "13",
  "operation_support_type": "office hours",
  "ssl_transport": "required",
  "enable_backup_configuration": true,
  "backup_retention": "3",
  "enable_backup_encryption": false
}

POST

Delete Container

Parameter	Type	Required	Possible Values
confirmConfirm Deletion	boolean	true

Example Data Payload:

{
  "confirm": true
}

POST

Edit Container

Parameter	Type	Required	Possible Values
friendly_nameFriendly name for this Container for PostgreSQL instances. With this name, the Container can be identified on the bill.	string	true
planNameDefines the service class. BASIC: All PostgreSQL Instances in this Container are located in one datacenter without geographical redundancy. ADVANCED: All PostgreSQL Instances in this Container are replicated to a second datacenter for geographical data redundancy. Higher costs per vCPU will also be charged as technically twice the amount of vCPU and RAM are produced.	string	true	See List Basic Advanced
vm_cpu_countNumber of (net) vCPUs allocated to a Container (VM). 1 vCPU corresponds to a CPU thread, i.e. 0.5 Intel Core. The minimum order size is 2 vCPU (=2*0.5 = 1 Intel x86 Core). The maximum order size = 88 vCPU. Per vCPU are 8GB memory assigned (e.g. 4 vCPU * 8GB = 32GB RAM for the VM)	number	true

Example Data Payload:

{
  "friendly_name": "mysql-instance",
  "planName": "Basic",
  "vm_cpu_count": 2
}

POST

Set CID Status

Parameter	Type	Required	Possible Values
p_enable_cidContains System CID?	boolean	true
p_confirmI have read and understood this information	boolean	true

Example Data Payload:

{
  "p_enable_cid": true,
  "p_confirm": true
}

POST

Manage Storage

Manage Storage Managed PostgreSQL Container

Parameter	Type	Required	Possible Values
storage_sizeAllocated Storage Size (GB). Increase the allocated storage in GB which can be used by the instances. The entered value reflects the new absolut size not the increase, and must be Integer. The new value must be bigger than the current allocated storage size. Please make sure that the increase is below 1000GB (e.g. from 500GB to 1200GB). Otherwise execute this action multiple times in a row. Decreasing the storage is not supported.	number	true	Regex /^[0-9]+$/ No Match
enable_storage_auto_extendEnable Storage Auto Extend. Enable or disable the automatic growth of your PostgreSQL data file storage. If set to "true" the storage volume grows automatically when a certain "used space" threshold is reached. The volume is increased based on the following rule: If the current storage size is <100GB the next extent size is 5GB otherwise 5% of the current size.	boolean	true	See List true false

Example Data Payload:

{
  "storage_size": 10,
  "enable_storage_auto_extend": true
}

POST

Change Max. Instance Count

Change Max. Instance Count Managed PostgreSQL Container

Parameter	Type	Required	Possible Values
maxInstanceCountMaximum number of instances allowed in this container. Changing this value will restart all instances in the container!This number must be within 1 and 10.Recommendation: The number of instances in a container should not be higher than the currently assigned vCPU cores.	string	true	See List 1 2 3 4 5 6 7 8 9 10
confirmEnable Storage Auto Extend. Enable or disable the automatic growth of your PostgreSQL data file storage. If set to "true" the storage volume grows automatically when a certain "used space" threshold is reached. The volume is increased based on the following rule: If the current storage size is <100GB the next extent size is 5GB otherwise 5% of the current size.	boolean	true

Example Data Payload:

{
  "maxInstanceCount": "2",
  "confirm": true
}

POST

Upgrade Instances

Parameter	Type	Required	Possible Values
!!! Item not in template! provider-__asd_tenantRef__asd_tenantRef	string
!!! Item not in template! provider-__asd_subtenantRef__asd_subtenantRef	string
!!! Item not in template! provider-__containerId__containerId	string
!!! Item not in template! provider-__planId__planId	string
!!! Item not in template! provider-__serviceId__serviceId	string
!!! Item not in template! provider-major_versionAttention: The upgrade workflow restarts and upgrades all instances that belong to the same container and the same major version (e.g. 14).	string		See List 13 14
!!! Item not in template! provider-affected_instancesInstances which will be affected by the upgrade.	string
!!! Item not in template! provider-warning	string		Fixed ValueThe upgrade workflow will restart ALL (!) instances in this container which belongs to the selected major release.
__asd_subtenantRef__asd_subtenantRef	string
__asd_tenantRef__asd_tenantRef	string
major_versionAttention: The upgrade workflow restarts and upgrades all instances that belong to the same container and the same major version (e.g. 14).	string		See List 13 14

Example Data Payload:

{
  "provider-__containerId": "ae1f24ff-7b96-4ed9-aa2a-e7985e82783f",
  "provider-__planId": "f84bcfb7-b012-404b-a590-7acaa8d188d5",
  "provider-__serviceId": "c3ddadaa-e53c-4e49-96ee-2e6c7c0ba42a",
  "provider-affected_instances": "",
  "provider-warning": "The upgrade workflow will restart ALL (!) instances in this container which belongs to the selected major release."
}

Managed PostgreSQL Container can be found under catalog requests.

Instance Actions

Actions to be executed on a MPDS instance.

POST

Clone Instance

Parameter	Type	Required	Possible Values
instance_clone_typeDefines the clone type for the cloned Cluster Instance. SNAPSHOT: The cloned Cluster Instance is based on a snapshot from its source Cluster Instance and remains therefore dependent on the source Cluster Instance. This means it has initially the same content but not the size. The clone size grows with the data changes. All unchanged data in the clone refers to the source Cluster Instance. Therefore the source cannot be deleted as long as any related snapshot Cluster Instance does exist. RESTORE: The source Cluster Instance is restored to a point-in-time from the past into a new Cluster Instance. It has the same size and it is completely independent from the source Cluster Instance. As target the new Cluster Instance can be located in the same or another Container. The source Container must have backup enabled.	string	false	See List snapshot restore
instance_clone_timestampClone the Instance to the given timestamp. Timestamp must not point to the future and must not be older than 11 days. Format: YYYY-MM-DD hh:mm:ss. Please specify the timestamp in UTC.	string	false	Regex /^([2][0][1|2][0-9])-(([0][1-9])|([1][0-2]))-(([0][1-9])|([1-2][0-9])|([3][0-1])) (([0-1][0-9])|([2][0-3])):([0-5][0-9]):([0-5][0-9])$/ No Match
target_container_instance_idOnly used during "restore" when the clone should be create in another Container. Choose the Container where the new Cluster Instance must be restored. It can be the same or another Container. The source container and target container need to be part of the same Business Group and need to have the same major release version.	string	false
__containerIdContainer Id of the source Container. This value is required.	string	true
instance_friendly_nameFriendly name for this PostgreSQL Instance. With this name, the corresponding instance is visible on the bill and consumption report. Format: Characters, numbers, underscore "_" and dash "-")	string	false
instance_replication_modeDefines the Standby protection mode for the ADVANCED plan.ASYNC mode is the default and uses asynchronous network transport without automatic failover.SYNC_MANUAL mode enables synchronous network transport without automatic failover in case the Master instance crashes.SYNC_AUTO mode enables synchronous network transport between the Master and the Standby database including automatic failover in case the Master instance crashes.	string	true	See List ASNC SYNC_AUTO SYNC_MANUAL
instance_operation_support_typeDetermines the period in which the Instance is monitored and when incidents are worked on.	string	false	See List office hours 7x24h
instance_pg_version_typeSpecifies the major PostgreSQL version for the Instance - for clone it needs to be the same as the Version number from the source Instance.	string	true	See List 13 14
instance_ssl_transportDefines if secure SSL connections from client to server are enforced (required) or not (optional).	string	true	See List required optional
instance_enable_backup_configurationIf this option is selected, an Instance backup will be set up with point in time restore capabilities. Choosing this option causes additional costs. The amount of storage used on the backup system is charged in GB.	boolean	true
instance_backup_retentionBackup Retention (days). Define how long backups must be stored for this Instance.	string	true	See List 3 11 30 90
instance_enable_backup_encryptionIf this option is selected the backup files are encrypted. Choosing this option can cause higher CPU load during the backup operation. Disabling/Enabling this option will make existing backups unaccessible and the retention starts from zero. The operation deletes existing backups and creates a new full backup.	boolean	false

Example Data Payload:

{
  "instance_clone_type": "snapshot",
  "instance_clone_timestamp": "2021-12-03 10:15:30",
  "target_container_instance_id": "58b22aae-35f7-4da4-b131-03162d039264",
  "__containerId": "58b22aae-35f7-4da4-b131-03162d039264",
  "instance_friendly_name": "mpds-instance",
  "instance_replication_mode": "ASYNC",
  "instance_operation_support_type": "office hours",
  "instance_pg_version_type": "13",
  "instance_ssl_transport": "required",
  "instance_enable_backup_configuration": true,
  "instance_backup_retention": "1",
  "instance_enable_backup_encryption": true
}

POST

Delete Instance

Parameter	Type	Required	Possible Values
Confirm DeletionConfirm Deletion	boolean	true

Example Data Payload:

{
  "Confirm Deletion": true
}

POST

Edit Instance

Parameter	Type	Required	Possible Values
friendly_nameFriendly name for this PostgreSQL Instance. With this name, the corresponding instance is visible on the bill and consumption report. Format: Characters, numbers, underscore "_" and dash "-")	string	false
operation_support_typeDetermines the period in which the Instance is monitored and when incidents are worked on.	string	false	See List office hours 7x24h
replication_modeDefines the Standby protection mode for the ADVANCED plan.ASYNC mode is the default and uses asynchronous network transport without automatic failover.SYNC_MANUAL mode enables synchronous network transport without automatic failover in case the Master instance crashes.SYNC_AUTO mode enables synchronous network transport between the Master and the Standby database including automatic failover in case the Master instance crashes.	string	true	See List ASNC SYNC_AUTO SYNC_MANUAL
ssl_transportDefines if secure SSL connections from client to server are enforced (required) or not (optional).	string	true	See List required optional
enable_backup_configurationIf this option is selected, an Instance backup will be set up with point in time restore capabilities. Choosing this option causes additional costs. The amount of storage used on the backup system is charged in GB.	boolean	true
backup_retentionBackup Retention (days). Define how long backups must be stored for this Instance.	string	true	See List 3 11 30 90
enable_backup_encryptionIf this option is selected the backup files are encrypted. Choosing this option can cause higher CPU load during the backup operation. Disabling/Enabling this option will make existing backups unaccessible and the retention starts from zero. The operation deletes existing backups and creates a new full backup.	boolean	false
confirm_backup_encryptionDisabling/Enabling encryption will make existing backups unaccessible and the retention starts from zero. The operation deletes existing backups and creates a new full backup. Are you sure?	boolean	true

Example Data Payload:

{
  "friendly_name": "mpds-instance",
  "operation_support_type": "office hours",
  "replication_mode": "ASYNC",
  "ssl_transport": "required",
  "enable_backup_configuration": true,
  "backup_retention": "1",
  "enable_backup_encryption": true,
  "confirm_backup_encryption": true
}

POST

Get Credentials

No parameters needed, empty data payload is sufficient.

Example Data Payload:

{}

POST

Restart Instance

No parameters needed, empty data payload is sufficient.

Example Data Payload:

{}

POST

Restore Instance

Restore a MPDS Instance from a specific restore point

Parameter	Type	Required	Possible Values
instancePitrTimestampRestore Point (YYYY-MM-DD hh:mm:ss). The instance can be restored to any time within the retention time (UTC).	string	true	Regex /^([2][0][1|2][0-9])-(([0][1-9])|([1][0-2]))-(([0][1-9])|([1-2][0-9])|([3][0-1])) (([0-1][0-9])|([2][0-3])):([0-5][0-9]):([0-5][0-9])$/ No Match

Example Data Payload:

{
  "instancePitrTimestamp": "2021-12-12 10:20:00"
}

Credentials Actions

Actions to be executed on a Managed PostgreSQL Credentials instance.

POST

Delete Credentials

No parameters needed, empty data payload is sufficient.

Example Data Payload:

{}

Managed Reverse Proxy

POST

Generate new CSR

Use this action to generate and fetch a new certificate signing request from your instance

Parameter	Type	Required	Possible Values
organization	string	true
city	string	true
state	string	true
country	string	true

Example Data Payload:

{
  "organization": "MyCompany.ch",
  "city": "Bern",
  "state": "BE",
  "country": "CH"
}

POST

Upload Certificate

Use this action to upload and activate a certificate on your instance

Parameter	Type	Required	Possible Values
certificate	string	true

Example Data Payload:

{
  "certificate": "-----BEGIN CERTIFICATE----- <certificate> -----END CERTIFICATE-----"
}

POST

Delete Managed Reverse Proxy

Parameter	Type	Required	Possible Values
confirm	boolean	true

Example Data Payload:

{
  "confirm": true
}

POST

Update Managed Reverse Proxy

Use this action to change your instance settings

Parameter	Type	Required	Possible Values
planNamePlan Name. Changing from any Prod Plan Name (S, M, L or XL) to "S non Prod" Plan Name is not allowed	string	true	See List S S non Prod M L XL
description	string	false
desiredCertProviderDesired Cert Provider. Parameter cannot be modified	string	true	See List Value hardcoded!
dnsIntegrationDNS Integration. Changing it from TRUE to FALSE is not allowed	boolean	true
ipAddressFamilyIP Address Family. Parameter cannot be modified	string	true	See List Value hardcoded!
redirectTlsRedirect http to https	boolean	true
serverAddressesBackend Server IP. IP address family of the backend server cannot be changed von IPv4 to IPv6 or IPv6 to IPv4	string	true
servicePortBackend Server Port	string	true
tlsReencryptBackend Server Re-encryption	boolean	true

Example Data Payload:

{
  "planName": "S",
  "description": "",
  "desiredCertProvider": "Public Cert provided by Swisscom",
  "dnsIntegration": true,
  "ipAddressFamily": "ipv4",
  "redirectTls": true,
  "serverAddresses": "10.10.10.101",
  "servicePort": "1443",
  "tlsReencrypt": true
}

Managed Forward Proxy

POST

Delete Managed Forward Proxy

Parameter	Type	Required	Possible Values
confirm	boolean	true

Example Data Payload:

{
  "confirm": true
}

POST

Update Managed Forward Proxy

Use this action to change your instance settings

Parameter	Type	Required	Possible Values
planNamePlan Name. Changing from any Prod Plan Name (S, M, L or XL) to "S non Prod" Plan Name is not allowed	string	true	See List S S non Prod M L XL
description	string	false
dnsIntegrationDNS Integration. Changing it from TRUE to FALSE is not allowed	boolean	true
ipAddressFamilyIP Address Family. Parameter cannot be modified	string	true	See List Value hardcoded!
allowListIpBasedAllow List IP Destination based. Enter IP addresses or subnets, each on one single line. The list can be empty, in this case the respective Forward Proxy instance is completely closed, and no IP address or subnet destinations can be reached	string	false
aclSrcIpAllowAllow List IP Source based. Enter IP addresses or subnets, each on one single line. The list can be empty, in this case no IP address or subnet can access the Managed Forward Proxy	string	false
allowListDomainBasedAllow List Domain Destination based. Enter hostnames or domains, each on one line. The list can be empty, in this case the respective Forward Proxy instance is completely closed, and no destination hostnames or domains can be reached	string	false
denyListIpBasedDeny List IP Destination based. Enter IP addresses or subnets, each on one single line. The list can be empty, in this case the respective Forward Proxy instance is controlled purely by the allow list	string	false
aclSrcIpDenyDeny List IP Source based. Enter IP addresses or subnets, each on one single line. The list can be empty, in this case the respective Forward Proxy instance is controlled purely by the allow list	string	false
denyListDomainBasedDeny List Domain Destination based. Enter hostnames or domains, each on one single line. The list can be empty, in this case the respective Forward Proxy instance is controlled purely by the allow list	string	false
enableSocksEnable Socks. The Socks proxy can forward TCP and UDP connections, helping to bypass network segmentation. It is a dynamic port forwarding technique	boolean	true

Example Data Payload:

{
  "planName": "S",
  "description": "",
  "dnsIntegration": true,
  "ipAddressFamily": "ipv4",
  "allowListIpBased": "10.10.11.0/25",
  "aclSrcIpAllow": "255.255.255.0/28",
  "allowListDomainBased": ".web.mydomain.com",
  "denyListIpBased": "12.10.11.0/25",
  "aclSrcIpDeny": "10.122.1.5",
  "denyListDomainBased": "*.com.ch",
  "enableSocks": true
}

Object Storage S3

POST

Edit Object Storage S3

Parameter	Type	Required	Possible Values
instanceNameFriendly name of the Object Storage S3 namespace.	string	true	Regex /^(?:[A-Za-z_][\w-]{0,40})$/ No Match
sharedWithSwisscomThis option allows management access for Swisscom to your S3 instance. This is needed for importing OVA images via this namespace.	boolean	false
sharedWithOthersIf needed, one or multiple IDs must be specified comma separated, no space allowed. Be aware that it enables access for external customers. In order to use the parameter, please open a Support Request.	string	false

Example Data Payload:

{
  "instanceName": "My S3 Service",
  "sharedWithSwisscom": false,
  "sharedWithOthers": ""
}

POST

Delete Object Storage S3

Parameter	Type	Required	Possible Values
confirm	boolean	true	Fixed Valuetrue

Example Data Payload:

{
  "confirm": true
}

POST

Create S3 User

Parameter	Type	Required	Possible Values
displayNameFriendly name of the S3 User.	string	true	Regex /^(?:[A-Za-z_][\w-]{0,40})$/ No Match
permissionSelect whether the user should have read/write or read-only permissions.	string	true	See List Read/Write Read-only

Example Data Payload:

{
  "displayName": "My-S3-User",
  "permission": "Read/Write"
}

S3 User

POST

Delete S3 User

Parameter	Type	Required	Possible Values
confirm	boolean	true	Fixed Valuetrue

Example Data Payload:

{
  "confirm": true
}

INFO

Get S3 Credentials

This action cannot be submitted. It is used to read values via the GUI. If you want to read the form values of this action, you have to use the forms API.

Payload for /forms/request/update:

{
  "affectedElements": ["provider-accessKeyID", "provider-secretAccessKey"]
}