Server definition
- Hash
- sha256:ae267edc95e681f20a3d3196ef7da087bb703fab40c01921f1d8d1ea21a1d572
- What it is
- What a remote MCP server returned when asked what it offers: 124 tools
The blob, as servednamed by its sha256
{
"instructions": null,
"tools": [
{
"description": "Cancels the specified object storage at the next possible date - Cancels the specified object storage at the next possible date. Please be aware of your contract periods.",
"inputSchema": {
"properties": {
"CancelObjectStorageBody": {
"properties": {
"cancelDate": {
"description": "Date of cancellation",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"objectStorageId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"objectStorageId",
"CancelObjectStorageBody"
],
"type": "object"
},
"name": "CancelObjectStorage",
"outputSchema": null
},
{
"description": "Add instance to a Private Network - Add a specific instance to a Private Network",
"inputSchema": {
"properties": {
"instanceId": {
"format": "int64",
"type": "integer"
},
"privateNetworkId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"privateNetworkId",
"instanceId"
],
"type": "object"
},
"name": "assignInstancePrivateNetwork",
"outputSchema": null
},
{
"description": "Assign a VIP to an VPS/VDS/Bare Metal - Assign a VIP to a VPS/VDS/Bare Metal using the machine id.",
"inputSchema": {
"properties": {
"ip": {
"type": "string"
},
"resourceId": {
"format": "int64",
"type": "integer"
},
"resourceType": {
"enum": [
"instances",
"bare-metal"
],
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"resourceId",
"ip",
"resourceType"
],
"type": "object"
},
"name": "assignIp",
"outputSchema": null
},
{
"description": "Bulk delete DNS zone records - Delete multiple zone records from a DNS Zone",
"inputSchema": {
"properties": {
"bulkDeleteDnsZoneRecordsBody": {
"properties": {
"recordIds": {
"description": "List of zone record ids to delete",
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
}
},
"required": [
"recordIds"
],
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
},
"zoneName": {
"type": "string"
}
},
"required": [
"x-request-id",
"zoneName",
"bulkDeleteDnsZoneRecordsBody"
],
"type": "object"
},
"name": "bulkDeleteDnsZoneRecords",
"outputSchema": null
},
{
"description": "Cancel a specific domain - Cancel a specific domain",
"inputSchema": {
"properties": {
"cancelDomainBody": {
"properties": {
"cancelDate": {
"description": "Date of cancellation",
"format": "date-time",
"type": "string"
},
"reason": {
"description": "Reason for cancelling an domain",
"enum": [
"Technical issues / Outages / Performance",
"Too expensive / price",
"Product not needed anymore",
"Bad customer support",
"Switch to a different Contabo product",
"Missing features",
"Other"
],
"type": "string"
},
"reasonText": {
"description": "Reason Text when `Other` reason got selected while cancelling an domain",
"type": "string"
}
},
"type": "object"
},
"domain": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"domain",
"cancelDomainBody"
],
"type": "object"
},
"name": "cancelDomain",
"outputSchema": null
},
{
"description": "Cancel specific instance by id - Your are free to cancel a previously created instance at any time.",
"inputSchema": {
"properties": {
"cancelInstanceBody": {
"properties": {
"cancelDate": {
"description": "Date of cancellation",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"instanceId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"instanceId",
"cancelInstanceBody"
],
"type": "object"
},
"name": "cancelInstance",
"outputSchema": null
},
{
"description": "Confirm transfer out for a domain - Confirm transfer out for a domain",
"inputSchema": {
"properties": {
"domain": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"domain"
],
"type": "object"
},
"name": "confirmDomainTransferOut",
"outputSchema": null
},
{
"description": "Create a new assignment for the tag - Create a new tag assignment. This marks the specified resource with the specified tag for organizing purposes or to restrict access to that resource.",
"inputSchema": {
"properties": {
"resourceId": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"tagId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"tagId",
"resourceType",
"resourceId"
],
"type": "object"
},
"name": "createAssignment",
"outputSchema": null
},
{
"description": "Provide a custom image - In order to provide a custom image please specify an URL from where the image can be directly downloaded. A custom image must be in either `.iso` or `.qcow2` format. Other formats will be rejected. Please note that downloading can take a while depending on network speed resp. bandwidth and size of image. You can check the status by retrieving information about the image via a GET request. Download will be rejected if you have exceeded your limits.",
"inputSchema": {
"properties": {
"createCustomImageBody": {
"properties": {
"description": {
"description": "Image Description",
"type": "string"
},
"name": {
"description": "Image Name",
"type": "string"
},
"osType": {
"description": "Provided type of operating system (OS). Please specify `Windows` for MS Windows and `Linux` for other OS. Specifying wrong OS type may lead to disfunctional cloud instance.",
"enum": [
"Windows",
"Linux"
],
"type": "string"
},
"url": {
"description": "URL from where the image has been downloaded / provided.",
"type": "string"
},
"version": {
"description": "Version number to distinguish the contents of an image. Could be the version of the operating system for example.",
"type": "string"
}
},
"required": [
"name",
"url",
"osType",
"version"
],
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"createCustomImageBody"
],
"type": "object"
},
"name": "createCustomImage",
"outputSchema": null
},
{
"description": "Create DNS zone - Creates a new DNS zone for a customer",
"inputSchema": {
"properties": {
"createDnsZoneBody": {
"properties": {
"zoneName": {
"description": "Zone name",
"type": "string"
}
},
"required": [
"zoneName"
],
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"createDnsZoneBody"
],
"type": "object"
},
"name": "createDnsZone",
"outputSchema": null
},
{
"description": "Create DNS zone record - Create resource record in a zone",
"inputSchema": {
"properties": {
"createDnsZoneRecordBody": {
"properties": {
"data": {
"description": "Data",
"minLength": 1,
"type": "string"
},
"flag": {
"description": "Flag",
"type": "number"
},
"name": {
"description": "Name, if empty the zone name will be used",
"minLength": 1,
"type": "string"
},
"port": {
"description": "Port",
"type": "number"
},
"prio": {
"description": "Prio",
"type": "number"
},
"tag": {
"description": "Tag",
"type": "string"
},
"ttl": {
"description": "TTL",
"type": "number"
},
"type": {
"description": "Type",
"minLength": 1,
"type": "string"
},
"weight": {
"description": "Weight",
"type": "number"
}
},
"required": [
"type",
"ttl",
"prio",
"data"
],
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
},
"zoneName": {
"type": "string"
}
},
"required": [
"x-request-id",
"zoneName",
"createDnsZoneRecordBody"
],
"type": "object"
},
"name": "createDnsZoneRecord",
"outputSchema": null
},
{
"description": "Create specific handle - Create specific handle",
"inputSchema": {
"properties": {
"createHandleBody": {
"properties": {
"address": {
"description": "Address details for handle",
"type": "string"
},
"birthInfo": {
"description": "The birth info of the handle",
"type": "string"
},
"email": {
"description": "Handle email",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"fax": {
"description": "Handle fax",
"type": "string"
},
"firstName": {
"description": "Handle first name",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"gender": {
"description": "Handle gender",
"enum": [
"male",
"female",
"na"
],
"type": "string"
},
"handleType": {
"description": "The type of the handle",
"enum": [
"person",
"organization"
],
"type": "string"
},
"lastName": {
"description": "Handle last name",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"organization": {
"description": "The organization of the handle",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"phone": {
"description": "Handle phone",
"type": "string"
}
},
"required": [
"handleType",
"firstName",
"lastName",
"email",
"gender",
"address",
"phone"
],
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"createHandleBody"
],
"type": "object"
},
"name": "createHandle",
"outputSchema": null
},
{
"description": "Create a new instance - Create a new instance for your account with the provided parameters. <table> <tr><th>ProductId</th><th>Product</th><th>Disk Size</th></tr> <tr><td>V91</td><td>VPS 10 NVMe</td><td>75 GB NVMe</td></tr> <tr><td>V92</td><td>VPS 10 SSD</td><td>150 GB SSD</td></tr> <tr><td>V93</td><td>VPS 10 Storage</td><td>300 GB SSD</td></tr> <tr><td>V94</td><td>VPS 20 NVMe</td><td>100 GB NVMe</td></tr> <tr><td>V95</td><td>VPS 20 SSD</td><td>200 GB SSD</td></tr> <tr><td>V96</td><td>VPS 20 Storage</td><td>400 GB SSD</td></tr> <tr><td>V97</td><td>VPS 30 NVMe</td><td>200 GB NVMe</td></tr> <tr><td>V98</td><td>VPS 30 SSD</td><td>400 GB SSD</td></tr> <tr><td>V99</td><td>VPS 30 Storage</td><td>1000 GB NVMe</td></tr> <tr><td>V100</td><td>VPS 40 NVMe</td><td>250 GB NVMe</td></tr> <tr><td>V101</td><td>VPS 40 SSD</td><td>500 GB SSD</td></tr> <tr><td>V102</td><td>VPS 40 Storage</td><td>1200 GB NVMe</td></tr> <tr><td>V103</td><td>VPS 50 NVMe</td><td>300 GB NVMe</td></tr> <tr><td>V104</td><td>VPS 50 SSD</td><td>600 GB SSD</td></tr> <tr><td>V105</td><td>VPS 50 Storage</td><td>1400 GB SSD</td></tr> <tr><td>V106</td><td>VPS 60 NVMe</td><td>350 GB NVMe</td></tr> <tr><td>V107</td><td>VPS 60 SSD</td><td>700 GB SSD</td></tr> <tr><td>V8</td><td>VDS S</td><td>180 GB NVMe</td></tr> <tr><td>V9</td><td>VDS M</td><td>240 GB NVMe</td></tr> <tr><td>V10</td><td>VDS L</td><td>360 GB NVMe</td></tr> <tr><td>V11</td><td>VDS XL</td><td>480 GB NVMe</td></tr> <tr><td>V16</td><td>VDS XXL</td><td>720 GB NVMe</td></tr> </table>",
"inputSchema": {
"properties": {
"createInstanceBody": {
"properties": {
"addOns": {
"description": "Set attributes in the addons object for the corresponding ones that need to be added to the instance",
"type": "string"
},
"applicationId": {
"description": "Application ID",
"type": "string"
},
"defaultUser": {
"description": "Default user name created for login during (re-)installation with administrative privileges. Allowed values for Linux/BSD are `admin` (use sudo to apply administrative privileges like root) or `root`. Allowed values for Windows are `admin` (has administrative privileges like administrator) or `administrator`.",
"enum": [
"root",
"admin",
"administrator"
],
"type": "string"
},
"displayName": {
"description": "The display name of the instance",
"maxLength": 255,
"type": "string"
},
"imageId": {
"description": "ImageId to be used to setup the compute instance. Default is Ubuntu 22.04",
"type": "string"
},
"license": {
"description": "Additional licence in order to enhance your chosen product, mainly needed for software licenses on your product (not needed for windows).",
"enum": [
"cPanel5",
"cPanel30",
"cPanel50",
"cPanel100",
"cPanel150",
"cPanel200",
"cPanel250",
"cPanel300",
"cPanel350",
"cPanel400",
"cPanel450",
"cPanel500",
"cPanel550",
"cPanel600",
"cPanel650",
"cPanel700",
"cPanel750",
"cPanel800",
"cPanel850",
"cPanel900",
"cPanel950",
"cPanel1000",
"PleskAdmin",
"PleskHost",
"PleskPro"
],
"type": "string"
},
"period": {
"description": "Initial contract period in months. Available periods are: 1, 3, 6 and 12 months. Default to 1 month",
"format": "int64",
"type": "integer"
},
"productId": {
"description": "Default is V92",
"minLength": 1,
"type": "string"
},
"region": {
"description": "Instance Region where the compute instance should be located. Default is EU",
"enum": [
"EU",
"US-central",
"US-east",
"US-west",
"SIN",
"UK",
"AUS",
"JPN",
"IND"
],
"minLength": 1,
"type": "string"
},
"rootPassword": {
"description": "`secretId` of the password for the `defaultUser` with administrator/root privileges. For Linux/BSD please use SSH, for Windows RDP. Please refer to Secrets Management API.",
"format": "int64",
"type": "integer"
},
"sshKeys": {
"description": "Array of `secretId`s of public SSH keys for logging into as `defaultUser` with administrator/root privileges. Applies to Linux/BSD systems. Please refer to Secrets Management API.",
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"userData": {
"description": "[Cloud-Init](https://cloud-init.io/) Config in order to customize during start of compute instance.",
"type": "string"
}
},
"required": [
"period"
],
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"createInstanceBody"
],
"type": "object"
},
"name": "createInstance",
"outputSchema": null
},
{
"description": "Create a new object storage - Create / purchase a new object storage in your account. Please note that you can only buy one object storage per location. You can actually increase the object storage space via `POST` to `/v1/object-storages/{objectStorageId}/resize`",
"inputSchema": {
"properties": {
"createObjectStorageBody": {
"properties": {
"autoScaling": {
"description": "Autoscaling settings",
"type": "string"
},
"displayName": {
"description": "Display name helps to differentiate between object storages, especially if they are in the same region. If display name is not provided, it will be generated. Display name can be changed any time.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"region": {
"description": "Region where the object storage should be located. Default is EU. Available regions: EU, US-central, SIN",
"minLength": 1,
"type": "string"
},
"totalPurchasedSpaceTB": {
"description": "Amount of purchased / requested object storage in TB.",
"format": "double",
"type": "number"
}
},
"required": [
"region",
"totalPurchasedSpaceTB"
],
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"createObjectStorageBody"
],
"type": "object"
},
"name": "createObjectStorage",
"outputSchema": null
},
{
"description": "Create a new Private Network - Create a new Private Network in your account.",
"inputSchema": {
"properties": {
"createPrivateNetworkBody": {
"properties": {
"description": {
"description": "The description of the Private Network. There is a limit of 255 characters per Private Network description.",
"maxLength": 255,
"type": "string"
},
"name": {
"description": "The name of the Private Network. It may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per Private Network name.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"region": {
"description": "Region where the Private Network should be located. Default is `EU`",
"minLength": 1,
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"createPrivateNetworkBody"
],
"type": "object"
},
"name": "createPrivateNetwork",
"outputSchema": null
},
{
"description": "Create a new PTR Record using ip address - Create a new PTR Record using ip address. Only IPv6 can be created",
"inputSchema": {
"properties": {
"createPtrRecordBody": {
"properties": {
"ip": {
"description": "IP Address",
"type": "string"
},
"ptr": {
"description": "PTR Record name",
"type": "string"
},
"ttl": {
"description": "Time to live for the PTR record in seconds",
"format": "int64",
"type": "integer"
}
},
"required": [
"ptr",
"ip",
"ttl"
],
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"createPtrRecordBody"
],
"type": "object"
},
"name": "createPtrRecord",
"outputSchema": null
},
{
"description": "Create a new role - Create a new role. In order to get a list availbale api enpoints (apiName) and their actions please refer to the GET api-permissions endpoint. For specifying `resources` please enter tag ids. For those to take effect please assign them to a resource in the tag management api.",
"inputSchema": {
"properties": {
"createRoleBody": {
"properties": {
"accessAllResources": {
"description": "Allow access to all resources. This will superseed all assigned resources in a role.",
"type": "boolean"
},
"admin": {
"description": "If user is admin he will have permissions to all API endpoints and resources. Enabling this will superseed all role definitions and `accessAllResources`.",
"type": "boolean"
},
"name": {
"description": "The name of the role. There is a limit of 255 characters per role.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"permissions": {
"items": {
"properties": {
"actions": {
"description": "Action allowed for the API endpoint. Basically `CREATE` corresponds to POST endpoints, `READ` to GET endpoints, `UPDATE` to PATCH / PUT endpoints and `DELETE` to DELETE endpoints.",
"items": {
"enum": [
"CREATE",
"READ",
"UPDATE",
"DELETE"
],
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "The name of the role. There is a limit of 255 characters per role.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"resources": {
"description": "The IDs of tags. Only if those tags are assgined to a resource the user with that role will be able to access the resource.",
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
}
},
"required": [
"apiName",
"actions"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"name",
"admin",
"accessAllResources"
],
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"createRoleBody"
],
"type": "object"
},
"name": "createRole",
"outputSchema": null
},
{
"description": "Create a new secret - Create a new secret in your account with attributes name, type and value. Attribute type can be password or ssh.",
"inputSchema": {
"properties": {
"createSecretBody": {
"properties": {
"name": {
"description": "The name of the secret that will keep the password",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"type": {
"description": "The type of the secret. Can be `password` or `ssh`",
"enum": [
"password",
"ssh"
],
"type": "string"
},
"value": {
"description": "The secret value that needs to be saved. In case of a password it must match a pattern with at least one upper and lower case character and either one number with two special characters `!@#$^&*?_~` or at least three numbers with one special character `!@#$^&*?_~`. This is expressed in the following regular expression: `^((?=.*?[A-Z]{1,})(?=.*?[a-z]{1,}))(((?=(?:[^d]*d){1})(?=([^^&*?_~]*[!@#$^&*?_~]){2,}))|((?=(?:[^d]*d){3})(?=.*?[!@#$^&*?_~]+))).{8,}$`",
"minLength": 8,
"type": "string"
}
},
"required": [
"name",
"value",
"type"
],
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"createSecretBody"
],
"type": "object"
},
"name": "createSecret",
"outputSchema": null
},
{
"description": "Create a new instance snapshot - Create a new snapshot for instance, with name and description attributes",
"inputSchema": {
"properties": {
"createSnapshotBody": {
"properties": {
"description": {
"description": "The description of the snapshot. There is a limit of 255 characters per snapshot.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"name": {
"description": "The name of the snapshot. It may contain letters, numbers, spaces, dashes. There is a limit of 30 characters per snapshot.",
"maxLength": 30,
"minLength": 1,
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"instanceId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"instanceId",
"createSnapshotBody"
],
"type": "object"
},
"name": "createSnapshot",
"outputSchema": null
},
{
"description": "Create a new tag - Create a new tag in your account with attribute name and optional attribute color.",
"inputSchema": {
"properties": {
"createTagBody": {
"properties": {
"color": {
"description": "The color of the tag. Color can be specified using hexadecimal value. Default color is #0A78C3",
"maxLength": 7,
"minLength": 4,
"type": "string"
},
"description": {
"description": "The description of the Tag name. ",
"type": "string"
},
"name": {
"description": "The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag.",
"maxLength": 255,
"minLength": 1,
"type": "string"
}
},
"required": [
"name",
"color"
],
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"createTagBody"
],
"type": "object"
},
"name": "createTag",
"outputSchema": null
},
{
"description": "Create a new user - Create a new user with required attributes name, email, enabled, totp (=Two-factor authentication 2FA), admin (=access to all endpoints and resources), accessAllResources and roles. You can't specify any password / secrets for the user. For security reasons the user will have to specify secrets on his own.",
"inputSchema": {
"properties": {
"createUserBody": {
"properties": {
"email": {
"description": "The email of the user to which activation and forgot password links are being sent to. There is a limit of 255 characters per email.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"enabled": {
"description": "If user is not enabled, he can't login and thus use services any longer.",
"type": "boolean"
},
"firstName": {
"description": "The name of the user. Names may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per user.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"lastName": {
"description": "The last name of the user. Users may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per user.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"locale": {
"description": "The locale of the user. This can be `de-DE`, `de`, `en-US`, `en`, `es-ES`, `es`, `pt-BR`, `pt`.",
"enum": [
"de-DE",
"de",
"en-US",
"en",
"es",
"es-ES",
"pt-BR",
"pt"
],
"type": "string"
},
"roles": {
"description": "The roles as list of `roleId`s of the user.",
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"totp": {
"description": "Enable or disable two-factor authentication (2FA) via time based OTP.",
"type": "boolean"
}
},
"required": [
"email",
"enabled",
"totp",
"locale"
],
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"createUserBody"
],
"type": "object"
},
"name": "createUser",
"outputSchema": null
},
{
"description": "Delete existing tag assignment - Tag assignment will be removed from the specified resource. If this tag is being used for access restrictions the affected users will no longer be able to access that resource.",
"inputSchema": {
"properties": {
"resourceId": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"tagId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"tagId",
"resourceType",
"resourceId"
],
"type": "object"
},
"name": "deleteAssignment",
"outputSchema": null
},
{
"description": "Delete a DNS zone. - Delete a DNS Zone using zone name.",
"inputSchema": {
"properties": {
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
},
"zoneName": {
"type": "string"
}
},
"required": [
"x-request-id",
"zoneName"
],
"type": "object"
},
"name": "deleteDnsZone",
"outputSchema": null
},
{
"description": "Delete a DNS zone record - Delete a DNZ Zone's record",
"inputSchema": {
"properties": {
"recordId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
},
"zoneName": {
"type": "string"
}
},
"required": [
"x-request-id",
"recordId",
"zoneName"
],
"type": "object"
},
"name": "deleteDnsZoneRecord",
"outputSchema": null
},
{
"description": "Delete an uploaded custom image by its id - Your are free to delete a previously uploaded custom images at any time",
"inputSchema": {
"properties": {
"imageId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"imageId"
],
"type": "object"
},
"name": "deleteImage",
"outputSchema": null
},
{
"description": "Delete existing Private Network by id - Delete existing Virtual Private Cloud by id and automatically unassign all instances from it",
"inputSchema": {
"properties": {
"privateNetworkId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"privateNetworkId"
],
"type": "object"
},
"name": "deletePrivateNetwork",
"outputSchema": null
},
{
"description": "Delete a PTR Record using ip address - Delete a PTR Record using ip address. Only IPv6 can be deleted",
"inputSchema": {
"properties": {
"ipAddress": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"ipAddress"
],
"type": "object"
},
"name": "deletePtrRecord",
"outputSchema": null
},
{
"description": "Delete existing role by id - You can't delete a role if it is still assigned to a user. In such cases please remove the role from the users.",
"inputSchema": {
"properties": {
"roleId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"roleId"
],
"type": "object"
},
"name": "deleteRole",
"outputSchema": null
},
{
"description": "Delete existing secret by id - You can remove a specific secret from your account.",
"inputSchema": {
"properties": {
"secretId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"secretId"
],
"type": "object"
},
"name": "deleteSecret",
"outputSchema": null
},
{
"description": "Delete existing snapshot by id - Delete existing instance snapshot by id",
"inputSchema": {
"properties": {
"instanceId": {
"format": "int64",
"type": "integer"
},
"snapshotId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"instanceId",
"snapshotId"
],
"type": "object"
},
"name": "deleteSnapshot",
"outputSchema": null
},
{
"description": "Delete existing tag by id - Your tag can be deleted if it is not assigned to any resource on your account. Check tag assigments before deleting tag.",
"inputSchema": {
"properties": {
"tagId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"tagId"
],
"type": "object"
},
"name": "deleteTag",
"outputSchema": null
},
{
"description": "Delete existing user by id - By deleting a user he will not be able to access any endpoints or resources any longer. In order to temporarily disable a user please update its `enabled` attribute.",
"inputSchema": {
"properties": {
"userId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"userId"
],
"type": "object"
},
"name": "deleteUser",
"outputSchema": null
},
{
"description": "Generate new client secret - Generate and get new client secret.",
"inputSchema": {
"properties": {
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "generateClientSecret",
"outputSchema": null
},
{
"description": "Get auth code for a domain - Get auth code for a domain by id",
"inputSchema": {
"properties": {
"domain": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"domain"
],
"type": "object"
},
"name": "getAuthCode",
"outputSchema": null
},
{
"description": "Get S3 compatible object storage credentials. - Get S3 compatible object storage credentials for accessing it via S3 compatible tools like `aws` cli.",
"inputSchema": {
"properties": {
"credentialId": {
"format": "int64",
"type": "integer"
},
"objectStorageId": {
"type": "string"
},
"userId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"userId",
"objectStorageId",
"credentialId"
],
"type": "object"
},
"name": "getObjectStorageCredentials",
"outputSchema": null
},
{
"description": "List all domains - List and filter all your domains",
"inputSchema": {
"properties": {
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"size": {
"format": "int64",
"type": "integer"
},
"sld": {
"type": "string"
},
"status": {
"enum": [
"ready",
"processing",
"transferring in",
"transferring out",
"manual_task",
"transferred"
],
"type": "string"
},
"tld": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "listDomains",
"outputSchema": null
},
{
"description": "List all handles - List and filter all your handles",
"inputSchema": {
"properties": {
"countries": {
"type": "string"
},
"firstName": {
"type": "string"
},
"handleType": {
"type": "string"
},
"lastName": {
"type": "string"
},
"name": {
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"search": {
"type": "string"
},
"showDefaults": {
"type": "boolean"
},
"size": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "listHandles",
"outputSchema": null
},
{
"description": "Get list of S3 compatible object storage credentials for user. - Get list of S3 compatible object storage credentials for accessing it via S3 compatible tools like `aws` cli.",
"inputSchema": {
"properties": {
"displayName": {
"type": "string"
},
"objectStorageId": {
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"regionName": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"userId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"userId"
],
"type": "object"
},
"name": "listObjectStorageCredentials",
"outputSchema": null
},
{
"description": "Create or transfer a domain - Create or transfer a domain",
"inputSchema": {
"properties": {
"orderDomainBody": {
"properties": {
"authCode": {
"description": "The domain auth code",
"type": "string"
},
"domain": {
"description": "Domain name",
"type": "string"
},
"handles": {
"description": "The handles of the domain",
"type": "string"
},
"nameservers": {
"description": "Nameservers",
"items": {
"properties": {
"hostname": {
"description": "Nameservers",
"items": {
"type": "string"
},
"type": "array"
},
"ipV4": {
"description": "IPv4 of nameserver",
"items": {
"type": "string"
},
"type": "array"
},
"ipV6": {
"description": "IPv6 of nameserver",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"hostname"
],
"type": "object"
},
"type": "array"
},
"resourceId": {
"description": "The identifier of the resource id",
"type": "string"
},
"resourceType": {
"description": "The identifier of the resource type",
"enum": [
"instance",
"server",
"package"
],
"type": "string"
}
},
"required": [
"domain",
"handles",
"nameservers"
],
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"orderDomainBody"
],
"type": "object"
},
"name": "orderDomain",
"outputSchema": null
},
{
"description": "Update specific instance - Update specific instance by instanceId.",
"inputSchema": {
"properties": {
"instanceId": {
"format": "int64",
"type": "integer"
},
"patchInstanceBody": {
"properties": {
"displayName": {
"description": "The display name of the instance",
"maxLength": 255,
"type": "string"
}
},
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"instanceId",
"patchInstanceBody"
],
"type": "object"
},
"name": "patchInstance",
"outputSchema": null
},
{
"description": "Update a Private Network by id - Update a Private Network by id in your account.",
"inputSchema": {
"properties": {
"patchPrivateNetworkBody": {
"properties": {
"description": {
"description": "The description of the Private Network. There is a limit of 255 characters per Private Network.",
"maxLength": 255,
"type": "string"
},
"name": {
"description": "The name of the Private Network. It may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per Private Network.",
"maxLength": 255,
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"privateNetworkId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"privateNetworkId",
"patchPrivateNetworkBody"
],
"type": "object"
},
"name": "patchPrivateNetwork",
"outputSchema": null
},
{
"description": "Regenerates secret key of specified user for the S3 compatible object storages. - Regenerates secret key of specified user for the a specific S3 compatible object storages.",
"inputSchema": {
"properties": {
"credentialId": {
"format": "int64",
"type": "integer"
},
"objectStorageId": {
"type": "string"
},
"userId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"userId",
"objectStorageId",
"credentialId"
],
"type": "object"
},
"name": "regenerateObjectStorageCredentials",
"outputSchema": null
},
{
"description": "Reinstall specific instance - You can reinstall a specific instance with a new image and optionally add ssh keys, a root password or cloud-init.",
"inputSchema": {
"properties": {
"instanceId": {
"format": "int64",
"type": "integer"
},
"reinstallInstanceBody": {
"properties": {
"applicationId": {
"description": "Application ID",
"type": "string"
},
"defaultUser": {
"description": "Default user name created for login during (re-)installation with administrative privileges. Allowed values for Linux/BSD are `admin` (use sudo to apply administrative privileges like root) or `root`. Allowed values for Windows are `admin` (has administrative privileges like administrator) or `administrator`.",
"enum": [
"root",
"admin",
"administrator"
],
"type": "string"
},
"imageId": {
"description": "ImageId to be used to setup the compute instance.",
"type": "string"
},
"rootPassword": {
"description": "`secretId` of the password for the `defaultUser` with administrator/root privileges. For Linux/BSD please use SSH, for Windows RDP. Please refer to Secrets Management API.",
"format": "int64",
"type": "integer"
},
"sshKeys": {
"description": "Array of `secretId`s of public SSH keys for logging into as `defaultUser` with administrator/root privileges. Applies to Linux/BSD systems. Please refer to Secrets Management API.",
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"userData": {
"description": "[Cloud-Init](https://cloud-init.io/) Config in order to customize during start of compute instance.",
"type": "string"
}
},
"required": [
"imageId"
],
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"instanceId",
"reinstallInstanceBody"
],
"type": "object"
},
"name": "reinstallInstance",
"outputSchema": null
},
{
"description": "Remove specific handle - Remove specific handle",
"inputSchema": {
"properties": {
"handleId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"handleId"
],
"type": "object"
},
"name": "removeHandle",
"outputSchema": null
},
{
"description": "Rescue a compute instance / resource identified by its id - You can reboot your instance in rescue mode to resolve system issues. Rescue system is Linux based and its booted instead of your regular operating system. The disk containing your operating sytstem, software and your data is already mounted for you to access and repair/modify files. After a reboot your compute instance will boot your operating system. Please note that this is for advanced users.",
"inputSchema": {
"properties": {
"instanceId": {
"format": "int64",
"type": "integer"
},
"rescueBody": {
"properties": {
"rootPassword": {
"description": "`secretId` of the password to login into rescue system for the `root` user.",
"format": "int64",
"type": "integer"
},
"sshKeys": {
"description": "Array of `secretId`s of public SSH keys for logging into rescue system as `root` user.",
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"userData": {
"description": "[Cloud-Init](https://cloud-init.io/) Config in order to customize during start of compute instance.",
"type": "string"
}
},
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"instanceId",
"rescueBody"
],
"type": "object"
},
"name": "rescue",
"outputSchema": null
},
{
"description": "Resend email verification - Resend email verification for a specific user",
"inputSchema": {
"properties": {
"redirectUrl": {
"type": "string"
},
"userId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"userId"
],
"type": "object"
},
"name": "resendEmailVerification",
"outputSchema": null
},
{
"description": "Send reset password email - Send reset password email for a specific user",
"inputSchema": {
"properties": {
"redirectUrl": {
"type": "string"
},
"userId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"userId"
],
"type": "object"
},
"name": "resetPassword",
"outputSchema": null
},
{
"description": "Reset password for a compute instance / resource referenced by an id - Reset password for a compute instance / resource referenced by an id. This will reset the current password to the password that you provided in the body of this request.",
"inputSchema": {
"properties": {
"instanceId": {
"format": "int64",
"type": "integer"
},
"resetPasswordActionBody": {
"properties": {
"rootPassword": {
"description": "`secretId` of the password for the `defaultUser` with administrator/root privileges. For Linux/BSD please use SSH, for Windows RDP. Please refer to Secrets Management API.",
"format": "int64",
"type": "integer"
},
"sshKeys": {
"description": "Array of `secretId`s of public SSH keys for logging into as `defaultUser` with administrator/root privileges. Applies to Linux/BSD systems. Please refer to Secrets Management API.",
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"userData": {
"description": "[Cloud-Init](https://cloud-init.io/) Config in order to customize during start of compute instance.",
"type": "string"
}
},
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"instanceId",
"resetPasswordActionBody"
],
"type": "object"
},
"name": "resetPasswordAction",
"outputSchema": null
},
{
"description": "Restart a compute instance / resource identified by its id. - To restart a compute instance that has been identified by its id, you should perform a restart action on it.",
"inputSchema": {
"properties": {
"instanceId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"instanceId"
],
"type": "object"
},
"name": "restart",
"outputSchema": null
},
{
"description": "List of API permissions - List all available API permissions. This list serves as a reference for specifying roles. As endpoints differ in their possibilities not all actions are available for each endpoint.",
"inputSchema": {
"properties": {
"apiName": {
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"size": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveApiPermissionsList",
"outputSchema": null
},
{
"description": "Get specific assignment for the tag - Get attributes for a specific tag assignment in your account. For this the resource type and resource id is required.",
"inputSchema": {
"properties": {
"resourceId": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"tagId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"tagId",
"resourceType",
"resourceId"
],
"type": "object"
},
"name": "retrieveAssignment",
"outputSchema": null
},
{
"description": "List tag assignments - List and filter all existing assignments for a tag in your account",
"inputSchema": {
"properties": {
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"resourceType": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"tagId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"tagId"
],
"type": "object"
},
"name": "retrieveAssignmentList",
"outputSchema": null
},
{
"description": "List history about your assignments (audit) - List and filters the history about your assignments.",
"inputSchema": {
"properties": {
"changedBy": {
"type": "string"
},
"endDate": {
"format": "date",
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"requestId": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"startDate": {
"format": "date",
"type": "string"
},
"tagId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveAssignmentsAuditsList",
"outputSchema": null
},
{
"description": "List statistics regarding the customer's custom images - List statistics regarding the customer's custom images such as the number of custom images uploaded, used disk space, free available disk space and total available disk space",
"inputSchema": {
"properties": {
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveCustomImagesStats",
"outputSchema": null
},
{
"description": "List data centers - List all data centers and their corresponding regions.",
"inputSchema": {
"properties": {
"name": {
"minLength": 1,
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"regionName": {
"minLength": 1,
"type": "string"
},
"regionSlug": {
"minLength": 1,
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"slug": {
"minLength": 1,
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveDataCenterList",
"outputSchema": null
},
{
"description": "Retrieve a DNS Zone by zone name - Get all attributes for a specific DNS Zone",
"inputSchema": {
"properties": {
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
},
"zoneName": {
"type": "string"
}
},
"required": [
"x-request-id",
"zoneName"
],
"type": "object"
},
"name": "retrieveDnsZone",
"outputSchema": null
},
{
"description": "List a DNS Zone's records - Get all the records of a DNS Zone",
"inputSchema": {
"properties": {
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"search": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
},
"zoneName": {
"type": "string"
}
},
"required": [
"x-request-id",
"zoneName"
],
"type": "object"
},
"name": "retrieveDnsZoneRecordsList",
"outputSchema": null
},
{
"description": "List DNS zones - Get a list of all zones",
"inputSchema": {
"properties": {
"customerId": {
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"size": {
"format": "int64",
"type": "integer"
},
"tenantId": {
"enum": [
"DE",
"INT"
],
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
},
"zoneName": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveDnsZonesList",
"outputSchema": null
},
{
"description": "List specific domain - List specific domain",
"inputSchema": {
"properties": {
"domain": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"domain"
],
"type": "object"
},
"name": "retrieveDomain",
"outputSchema": null
},
{
"description": "List history about your Domains (audit) - List and filters the history about your Domains.",
"inputSchema": {
"properties": {
"changedBy": {
"type": "string"
},
"domain": {
"type": "string"
},
"endDate": {
"format": "date",
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"requestId": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"startDate": {
"format": "date",
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveDomainsAuditsList",
"outputSchema": null
},
{
"description": "Get specific handle - Get specific handle",
"inputSchema": {
"properties": {
"handleId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"handleId"
],
"type": "object"
},
"name": "retrieveHandle",
"outputSchema": null
},
{
"description": "List history about your handles (audit) - List and filters the history about your handles.",
"inputSchema": {
"properties": {
"changedBy": {
"type": "string"
},
"endDate": {
"format": "date",
"type": "string"
},
"handleId": {
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"requestId": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"startDate": {
"format": "date",
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveHandlesAuditsList",
"outputSchema": null
},
{
"description": "Get details about a specific image by its id - Get details about a specific image. This could be either a standard or custom image. In case of an custom image you can also check the download status",
"inputSchema": {
"properties": {
"imageId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"imageId"
],
"type": "object"
},
"name": "retrieveImage",
"outputSchema": null
},
{
"description": "List history about your DNS Zones (audit) - List and filters the history about your DNS Zones .",
"inputSchema": {
"properties": {
"changedBy": {
"type": "string"
},
"endDate": {
"format": "date",
"type": "string"
},
"name": {
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"requestId": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"startDate": {
"format": "date",
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveImageAuditsList",
"outputSchema": null
},
{
"description": "List history about your custom images (audit) - List and filters the history about your custom images.",
"inputSchema": {
"properties": {
"changedBy": {
"type": "string"
},
"endDate": {
"format": "date",
"type": "string"
},
"imageId": {
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"requestId": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"startDate": {
"format": "date",
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveImageAuditsList1",
"outputSchema": null
},
{
"description": "List available standard and custom images - List and filter all available standard images provided by [Contabo](https://contabo.com) and your uploaded custom images.",
"inputSchema": {
"properties": {
"name": {
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"search": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"standardImage": {
"type": "boolean"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveImageList",
"outputSchema": null
},
{
"description": "Get specific instance by id - Get attributes values to a specific instance on your account.",
"inputSchema": {
"properties": {
"instanceId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"instanceId"
],
"type": "object"
},
"name": "retrieveInstance",
"outputSchema": null
},
{
"description": "List history about your actions (audit) triggered via the API - List and filters the history about your actions your triggered via the API.",
"inputSchema": {
"properties": {
"changedBy": {
"type": "string"
},
"endDate": {
"format": "date",
"type": "string"
},
"instanceId": {
"format": "int64",
"type": "integer"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"requestId": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"startDate": {
"format": "date",
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveInstancesActionsAuditsList",
"outputSchema": null
},
{
"description": "List history about your instances (audit) - List and filters the history about your instances.",
"inputSchema": {
"properties": {
"changedBy": {
"type": "string"
},
"endDate": {
"format": "date",
"type": "string"
},
"instanceId": {
"format": "int64",
"type": "integer"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"requestId": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"startDate": {
"format": "date",
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveInstancesAuditsList",
"outputSchema": null
},
{
"description": "List instances - List and filter all instances in your account",
"inputSchema": {
"properties": {
"addOnIds": {
"type": "string"
},
"customerId": {
"type": "string"
},
"dataCenter": {
"type": "string"
},
"displayName": {
"type": "string"
},
"instanceId": {
"format": "int64",
"type": "integer"
},
"instanceIds": {
"type": "string"
},
"ipConfig": {
"type": "boolean"
},
"name": {
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"productIds": {
"type": "string"
},
"productTypes": {
"type": "string"
},
"region": {
"type": "string"
},
"search": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"status": {
"enum": [
"provisioning",
"uninstalled",
"running",
"stopped",
"error",
"installing",
"unknown",
"manual_provisioning",
"product_not_available",
"verification_required",
"rescue",
"pending_payment",
"other",
"reset_password"
],
"type": "string"
},
"tenantId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveInstancesList",
"outputSchema": null
},
{
"description": "Get specific object storage by its id - Get data for a specific object storage on your account.",
"inputSchema": {
"properties": {
"objectStorageId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"objectStorageId"
],
"type": "object"
},
"name": "retrieveObjectStorage",
"outputSchema": null
},
{
"description": "List history about your object storages (audit) - List and filters the history about your object storages.",
"inputSchema": {
"properties": {
"changedBy": {
"type": "string"
},
"endDate": {
"format": "date",
"type": "string"
},
"objectStorageId": {
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"requestId": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"startDate": {
"format": "date",
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveObjectStorageAuditsList",
"outputSchema": null
},
{
"description": "List all your object storages - List and filter all object storages in your account",
"inputSchema": {
"properties": {
"dataCenterName": {
"minLength": 1,
"type": "string"
},
"displayName": {
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"region": {
"type": "string"
},
"s3TenantId": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveObjectStorageList",
"outputSchema": null
},
{
"description": "List usage statistics about the specified object storage - List usage statistics about the specified object storage such as the number of objects uploaded / created, used object storage space. Please note that the usage statistics are updated regularly and are not live usage statistics.",
"inputSchema": {
"properties": {
"objectStorageId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"objectStorageId"
],
"type": "object"
},
"name": "retrieveObjectStoragesStats",
"outputSchema": null
},
{
"description": "Get specific Private Network by id - Get attributes values to a specific Private Network on your account.",
"inputSchema": {
"properties": {
"privateNetworkId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"privateNetworkId"
],
"type": "object"
},
"name": "retrievePrivateNetwork",
"outputSchema": null
},
{
"description": "List history about your Private Networks (audit) - List and filters the history about your Private Networks.",
"inputSchema": {
"properties": {
"changedBy": {
"type": "string"
},
"endDate": {
"format": "date",
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"privateNetworkId": {
"format": "int64",
"type": "integer"
},
"requestId": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"startDate": {
"format": "date",
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrievePrivateNetworkAuditsList",
"outputSchema": null
},
{
"description": "List Private Networks - List and filter all Private Networks in your account",
"inputSchema": {
"properties": {
"dataCenter": {
"type": "string"
},
"instanceIds": {
"type": "string"
},
"name": {
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"region": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrievePrivateNetworkList",
"outputSchema": null
},
{
"description": "Retrieve a PTR Record by ip address - Get all attributes for a specific PTR Record",
"inputSchema": {
"properties": {
"ipAddress": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"ipAddress"
],
"type": "object"
},
"name": "retrievePtrRecord",
"outputSchema": null
},
{
"description": "List PTR records - Get a list of all PTR records, either customer or a list of IPs is required",
"inputSchema": {
"properties": {
"customerId": {
"type": "string"
},
"ips": {
"items": {
"type": "string"
},
"type": "array"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"search": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"tenantId": {
"enum": [
"DE",
"INT"
],
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrievePtrRecordsList",
"outputSchema": null
},
{
"description": "List history about your DNS Records (audit) - List and filter the history of changes made to your DNS Records.",
"inputSchema": {
"properties": {
"changedBy": {
"type": "string"
},
"endDate": {
"format": "date",
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"recordId": {
"format": "int64",
"type": "integer"
},
"requestId": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"startDate": {
"format": "date",
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveRecordAuditsList",
"outputSchema": null
},
{
"description": "Get specific role by id - Get attributes of specific role.",
"inputSchema": {
"properties": {
"roleId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"roleId"
],
"type": "object"
},
"name": "retrieveRole",
"outputSchema": null
},
{
"description": "List history about your roles (audit) - List and filter the history about your roles.",
"inputSchema": {
"properties": {
"changedBy": {
"type": "string"
},
"endDate": {
"format": "date",
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"requestId": {
"type": "string"
},
"roleId": {
"format": "int64",
"type": "integer"
},
"size": {
"format": "int64",
"type": "integer"
},
"startDate": {
"format": "date",
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveRoleAuditsList",
"outputSchema": null
},
{
"description": "List roles - List and filter all your roles. A role allows you to specify permission to api endpoints and resources like compute.",
"inputSchema": {
"properties": {
"apiName": {
"type": "string"
},
"name": {
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"size": {
"format": "int64",
"type": "integer"
},
"tagName": {
"type": "string"
},
"type": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveRoleList",
"outputSchema": null
},
{
"description": "Get specific secret by id - Get attributes values for a specific secret on your account.",
"inputSchema": {
"properties": {
"secretId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"secretId"
],
"type": "object"
},
"name": "retrieveSecret",
"outputSchema": null
},
{
"description": "List history about your secrets (audit) - List and filters the history about your secrets.",
"inputSchema": {
"properties": {
"changedBy": {
"type": "string"
},
"endDate": {
"format": "date",
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"requestId": {
"type": "string"
},
"secretId": {
"format": "int64",
"type": "integer"
},
"size": {
"format": "int64",
"type": "integer"
},
"startDate": {
"format": "date",
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveSecretAuditsList",
"outputSchema": null
},
{
"description": "List secrets - List and filter all secrets in your account.",
"inputSchema": {
"properties": {
"name": {
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"size": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"password",
"ssh"
],
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveSecretList",
"outputSchema": null
},
{
"description": "Retrieve a specific snapshot by id - Get all attributes for a specific snapshot",
"inputSchema": {
"properties": {
"instanceId": {
"format": "int64",
"type": "integer"
},
"snapshotId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"instanceId",
"snapshotId"
],
"type": "object"
},
"name": "retrieveSnapshot",
"outputSchema": null
},
{
"description": "List snapshots - List and filter all your snapshots for a specific instance",
"inputSchema": {
"properties": {
"instanceId": {
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"size": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"instanceId"
],
"type": "object"
},
"name": "retrieveSnapshotList",
"outputSchema": null
},
{
"description": "List history about your snapshots (audit) triggered via the API - List and filters the history about your snapshots your triggered via the API.",
"inputSchema": {
"properties": {
"changedBy": {
"type": "string"
},
"endDate": {
"format": "date",
"type": "string"
},
"instanceId": {
"format": "int64",
"type": "integer"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"requestId": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"snapshotId": {
"type": "string"
},
"startDate": {
"format": "date",
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveSnapshotsAuditsList",
"outputSchema": null
},
{
"description": "Get specific tag by id - Get attributes values to a specific tag on your account.",
"inputSchema": {
"properties": {
"tagId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"tagId"
],
"type": "object"
},
"name": "retrieveTag",
"outputSchema": null
},
{
"description": "List history about your assignments (audit) - List and filters the history about your assignments.",
"inputSchema": {
"properties": {
"changedBy": {
"type": "string"
},
"endDate": {
"format": "date",
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"requestId": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"startDate": {
"format": "date",
"type": "string"
},
"tagId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveTagAuditsList",
"outputSchema": null
},
{
"description": "List tags - List and filter all tags in your account",
"inputSchema": {
"properties": {
"name": {
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"size": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveTagList",
"outputSchema": null
},
{
"description": "Get specific user by id - Get attributes for a specific user.",
"inputSchema": {
"properties": {
"userId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"userId"
],
"type": "object"
},
"name": "retrieveUser",
"outputSchema": null
},
{
"description": "List history about your users (audit) - List and filter the history about your users.",
"inputSchema": {
"properties": {
"changedBy": {
"type": "string"
},
"endDate": {
"format": "date",
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"requestId": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"startDate": {
"format": "date",
"type": "string"
},
"userId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveUserAuditsList",
"outputSchema": null
},
{
"description": "Get client - Get idm client.",
"inputSchema": {
"properties": {
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveUserClient",
"outputSchema": null
},
{
"description": "Get user is password set status - Get info about idm user if the password is set.",
"inputSchema": {
"properties": {
"userId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveUserIsPasswordSet",
"outputSchema": null
},
{
"description": "List users - List and filter all your users.",
"inputSchema": {
"properties": {
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"owner": {
"type": "boolean"
},
"page": {
"format": "int64",
"type": "integer"
},
"size": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveUserList",
"outputSchema": null
},
{
"description": "Get specific VIP by ip - Get attributes values to a specific VIP on your account.",
"inputSchema": {
"properties": {
"ip": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"ip"
],
"type": "object"
},
"name": "retrieveVip",
"outputSchema": null
},
{
"description": "List history about your VIPs (audit) - List and filters the history about your VIPs.",
"inputSchema": {
"properties": {
"changedBy": {
"type": "string"
},
"endDate": {
"format": "date",
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"requestId": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"startDate": {
"format": "date",
"type": "string"
},
"vipId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveVipAuditsList",
"outputSchema": null
},
{
"description": "List VIPs - List and filter all vips in your account",
"inputSchema": {
"properties": {
"dataCenter": {
"type": "string"
},
"ip": {
"type": "string"
},
"ipVersion": {
"enum": [
"v4"
],
"type": "string"
},
"ips": {
"type": "string"
},
"orderBy": {
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"format": "int64",
"type": "integer"
},
"region": {
"type": "string"
},
"resourceDisplayName": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"resourceName": {
"type": "string"
},
"resourceType": {
"enum": [
"instances",
"bare-metal",
"null"
],
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"additional",
"floating"
],
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id"
],
"type": "object"
},
"name": "retrieveVipList",
"outputSchema": null
},
{
"description": "Revoke cancellation for a specific domain - Revoke cancellation for a specific domain",
"inputSchema": {
"properties": {
"domain": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"domain"
],
"type": "object"
},
"name": "revokeCancelDomain",
"outputSchema": null
},
{
"description": "Revoke transfer out for a domain - Revoke transfer out for a domain",
"inputSchema": {
"properties": {
"domain": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"domain"
],
"type": "object"
},
"name": "revokeDomainTransferOut",
"outputSchema": null
},
{
"description": "Revert the instance to a particular snapshot based on its identifier - Rollback the instance to a specific snapshot. In case the snapshot is not the latest one, it will automatically delete all the newer snapshots of the instance",
"inputSchema": {
"properties": {
"instanceId": {
"format": "int64",
"type": "integer"
},
"rollbackSnapshotBody": {
"properties": {},
"type": "object"
},
"snapshotId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"instanceId",
"snapshotId",
"rollbackSnapshotBody"
],
"type": "object"
},
"name": "rollbackSnapshot",
"outputSchema": null
},
{
"description": "Set default handle - Set default handle",
"inputSchema": {
"properties": {
"handleId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"handleId"
],
"type": "object"
},
"name": "setDefaultHandle",
"outputSchema": null
},
{
"description": "Shutdown compute instance / resource by its id - Shutdown an compute instance / resource. This is similar to pressing the power button on a physical machine. This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown.",
"inputSchema": {
"properties": {
"instanceId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"instanceId"
],
"type": "object"
},
"name": "shutdown",
"outputSchema": null
},
{
"description": "Start a compute instance / resource identified by its id - Starting a compute instance / resource is like powering on a real server. If the compute instance / resource is already started nothing will happen. You may check the current status anytime when getting information about a compute instance / resource.",
"inputSchema": {
"properties": {
"instanceId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"instanceId"
],
"type": "object"
},
"name": "start",
"outputSchema": null
},
{
"description": "Stop compute instance / resource by its id - Stopping a compute instance / resource is like powering off a real server. So please be aware that data may be lost. Alternatively you may log in and shut your compute instance / resource gracefully via the operating system. If the compute instance / resource is already stopped nothing will happen. You may check the current status anytime when getting information about a compute instance / resource.",
"inputSchema": {
"properties": {
"instanceId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"instanceId"
],
"type": "object"
},
"name": "stop",
"outputSchema": null
},
{
"description": "Search the available tool catalog to discover tools by name, description, or arguments. Use a regex pattern or natural language query to find relevant tools. Returns tool references that are automatically expanded into full tool definitions.",
"inputSchema": {
"properties": {
"mode": {
"description": "Search mode: \"regex\" for pattern matching, \"bm25\" for natural language. Defaults to \"bm25\".",
"enum": [
"regex",
"bm25"
],
"type": "string"
},
"query": {
"description": "A regex pattern or natural-language query to search tool names, descriptions, and argument names. Maximum 200 characters.",
"type": "string"
}
},
"required": [
"query"
],
"type": "object"
},
"name": "tool_search",
"outputSchema": null
},
{
"description": "Remove instance from a Private Network - Remove a specific instance from a Private Network",
"inputSchema": {
"properties": {
"instanceId": {
"format": "int64",
"type": "integer"
},
"privateNetworkId": {
"format": "int64",
"type": "integer"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"privateNetworkId",
"instanceId"
],
"type": "object"
},
"name": "unassignInstancePrivateNetwork",
"outputSchema": null
},
{
"description": "Unassign a VIP to a VPS/VDS/Bare Metal - Unassign a VIP from an VPS/VDS/Bare Metal using the machine id.",
"inputSchema": {
"properties": {
"ip": {
"type": "string"
},
"resourceId": {
"format": "int64",
"type": "integer"
},
"resourceType": {
"enum": [
"instances",
"bare-metal"
],
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"resourceId",
"ip",
"resourceType"
],
"type": "object"
},
"name": "unassignIp",
"outputSchema": null
},
{
"description": "Update DNS zone record - Create resource record in a zone",
"inputSchema": {
"properties": {
"recordId": {
"format": "int64",
"type": "integer"
},
"updateDnsZoneRecordBody": {
"properties": {
"data": {
"description": "Data",
"minLength": 1,
"type": "string"
},
"flag": {
"description": "Flag",
"type": "number"
},
"port": {
"description": "Port",
"type": "number"
},
"prio": {
"description": "Prio",
"type": "number"
},
"tag": {
"description": "Tag",
"type": "string"
},
"ttl": {
"description": "TTL",
"type": "number"
},
"weight": {
"description": "Weight",
"type": "number"
}
},
"required": [
"ttl",
"prio",
"data"
],
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
},
"zoneName": {
"type": "string"
}
},
"required": [
"x-request-id",
"recordId",
"zoneName",
"updateDnsZoneRecordBody"
],
"type": "object"
},
"name": "updateDnsZoneRecord",
"outputSchema": null
},
{
"description": "Update a specific domain - Update nameservers and handles for a specific domain",
"inputSchema": {
"properties": {
"domain": {
"type": "string"
},
"updateDomainBody": {
"properties": {
"handles": {
"description": "The handles of the domain",
"type": "string"
},
"nameservers": {
"description": "Nameservers",
"items": {
"properties": {
"hostname": {
"description": "Nameservers",
"items": {
"type": "string"
},
"type": "array"
},
"ipV4": {
"description": "IPv4 of nameserver",
"items": {
"type": "string"
},
"type": "array"
},
"ipV6": {
"description": "IPv6 of nameserver",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"hostname"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"domain",
"updateDomainBody"
],
"type": "object"
},
"name": "updateDomain",
"outputSchema": null
},
{
"description": "Update specific handle - Update specific handle",
"inputSchema": {
"properties": {
"handleId": {
"type": "string"
},
"updateHandleBody": {
"properties": {
"address": {
"description": "Address details for handle",
"type": "string"
},
"birthInfo": {
"description": "The birth info of the handle",
"type": "string"
},
"email": {
"description": "Handle email",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"fax": {
"description": "Handle fax",
"type": "string"
},
"gender": {
"description": "Handle gender",
"enum": [
"male",
"female",
"na"
],
"type": "string"
},
"phone": {
"description": "Handle phone",
"type": "string"
}
},
"required": [
"email",
"gender",
"address",
"phone"
],
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"handleId",
"updateHandleBody"
],
"type": "object"
},
"name": "updateHandle",
"outputSchema": null
},
{
"description": "Update custom image name by its id - Update name of the custom image",
"inputSchema": {
"properties": {
"imageId": {
"type": "string"
},
"updateImageBody": {
"properties": {
"description": {
"description": "Image Description",
"type": "string"
},
"name": {
"description": "Image Name",
"type": "string"
}
},
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"imageId",
"updateImageBody"
],
"type": "object"
},
"name": "updateImage",
"outputSchema": null
},
{
"description": "Modifies the display name of object storage - Modifies the display name of object storage. Display name must be unique.",
"inputSchema": {
"properties": {
"objectStorageId": {
"type": "string"
},
"updateObjectStorageBody": {
"properties": {
"displayName": {
"description": "Display name helps to differentiate between object storages, especially if they are in the same region.",
"maxLength": 255,
"minLength": 1,
"type": "string"
}
},
"required": [
"displayName"
],
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"objectStorageId",
"updateObjectStorageBody"
],
"type": "object"
},
"name": "updateObjectStorage",
"outputSchema": null
},
{
"description": "Edit a PTR Record by ip address - Edit attributes for a specific PTR Record",
"inputSchema": {
"properties": {
"ipAddress": {
"type": "string"
},
"updatePtrRecordBody": {
"properties": {
"ptr": {
"description": "PTR Record name",
"type": "string"
}
},
"required": [
"ptr"
],
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"ipAddress",
"updatePtrRecordBody"
],
"type": "object"
},
"name": "updatePtrRecord",
"outputSchema": null
},
{
"description": "Update specific role by id - Update attributes to your role. Attributes are optional. If not set, the attributes will retain their original values.",
"inputSchema": {
"properties": {
"roleId": {
"format": "int64",
"type": "integer"
},
"updateRoleBody": {
"properties": {
"accessAllResources": {
"description": "Allow access to all resources. This will superseed all assigned resources in a role.",
"type": "boolean"
},
"admin": {
"description": "If user is admin he will have permissions to all API endpoints and resources. Enabling this will superseed all role definitions and `accessAllResources`.",
"type": "boolean"
},
"name": {
"description": "The name of the role. There is a limit of 255 characters per role.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"permissions": {
"items": {
"properties": {
"actions": {
"description": "Action allowed for the API endpoint. Basically `CREATE` corresponds to POST endpoints, `READ` to GET endpoints, `UPDATE` to PATCH / PUT endpoints and `DELETE` to DELETE endpoints.",
"items": {
"enum": [
"CREATE",
"READ",
"UPDATE",
"DELETE"
],
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "The name of the role. There is a limit of 255 characters per role.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"resources": {
"description": "The IDs of tags. Only if those tags are assgined to a resource the user with that role will be able to access the resource.",
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
}
},
"required": [
"apiName",
"actions"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"name",
"admin",
"accessAllResources"
],
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"roleId",
"updateRoleBody"
],
"type": "object"
},
"name": "updateRole",
"outputSchema": null
},
{
"description": "Update specific secret by id - Update attributes to your secret. Attributes are optional. If not set, the attributes will retain their original values. Only name and value can be updated.",
"inputSchema": {
"properties": {
"secretId": {
"format": "int64",
"type": "integer"
},
"updateSecretBody": {
"properties": {
"name": {
"description": "The name of the secret to be saved",
"type": "string"
},
"value": {
"description": "The value of the secret to be saved",
"minLength": 8,
"type": "string"
}
},
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"secretId",
"updateSecretBody"
],
"type": "object"
},
"name": "updateSecret",
"outputSchema": null
},
{
"description": "Update specific snapshot by id - Update attributes of a snapshot. You may only specify the attributes you want to change. If an attribute is not set, it will retain its original value.",
"inputSchema": {
"properties": {
"instanceId": {
"format": "int64",
"type": "integer"
},
"snapshotId": {
"type": "string"
},
"updateSnapshotBody": {
"properties": {
"description": {
"description": "The description of the snapshot. There is a limit of 255 characters per snapshot.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"name": {
"description": "The name of the snapshot. Tags may contain only letters, numbers, spaces, dashes. There is a limit of 30 characters per snapshot.",
"maxLength": 30,
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"instanceId",
"snapshotId",
"updateSnapshotBody"
],
"type": "object"
},
"name": "updateSnapshot",
"outputSchema": null
},
{
"description": "Update specific tag by id - Update attributes to your tag. Attributes are optional. If not set, the attributes will retain their original values.",
"inputSchema": {
"properties": {
"tagId": {
"format": "int64",
"type": "integer"
},
"updateTagBody": {
"properties": {
"color": {
"description": "The color of the tag. Color can be specified using hexadecimal value. Default color is #0A78C3",
"maxLength": 7,
"minLength": 4,
"type": "string"
},
"description": {
"description": "The description of the Tag name. ",
"type": "string"
},
"name": {
"description": "The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag.",
"maxLength": 255,
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"tagId",
"updateTagBody"
],
"type": "object"
},
"name": "updateTag",
"outputSchema": null
},
{
"description": "Update specific user by id - Update attributes of a user. You may only specify the attributes you want to change. If an attribute is not set, it will retain its original value.",
"inputSchema": {
"properties": {
"updateUserBody": {
"properties": {
"email": {
"description": "The email of the user to which activation and forgot password links are being sent to. There is a limit of 255 characters per email.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"enabled": {
"description": "If user is not enabled, he can't login and thus use services any longer.",
"type": "boolean"
},
"firstName": {
"description": "The name of the user. Names may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per user.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"lastName": {
"description": "The last name of the user. Users may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per user.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"locale": {
"description": "The locale of the user. This can be `de-DE`, `de`, `en-US`, `en`, `es-ES`, `es`, `pt-BR`, `pt`.",
"enum": [
"de-DE",
"de",
"en-US",
"en",
"es",
"es-ES",
"pt-BR",
"pt"
],
"type": "string"
},
"roles": {
"description": "The roles as list of `roleId`s of the user.",
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"totp": {
"description": "Enable or disable two-factor authentication (2FA) via time based OTP.",
"type": "boolean"
}
},
"type": "object"
},
"userId": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"userId",
"updateUserBody"
],
"type": "object"
},
"name": "updateUser",
"outputSchema": null
},
{
"description": "Upgrading instance capabilities - In order to enhance your instance with additional features you can purchase add-ons. Currently only firewalling and private network addon is allowed.",
"inputSchema": {
"properties": {
"instanceId": {
"format": "int64",
"type": "integer"
},
"upgradeInstanceBody": {
"properties": {
"backup": {
"description": "Set this attribute if you want to upgrade your instance with the Automated Backup addon. Please provide an empty object for the time being as value. There will be more configuration possible in the future.",
"type": "string"
},
"privateNetworking": {
"description": "Set this attribute if you want to upgrade your instance with the Private Networking addon. Please provide an empty object for the time being as value. There will be more configuration possible in the future.",
"type": "string"
}
},
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"instanceId",
"upgradeInstanceBody"
],
"type": "object"
},
"name": "upgradeInstance",
"outputSchema": null
},
{
"description": "Upgrade object storage size resp. update autoscaling settings. - Upgrade object storage size. You can also adjust the autoscaling settings for your object storage. Autoscaling allows you to automatically purchase storage capacity on a monthly basis up to the specified limit.",
"inputSchema": {
"properties": {
"objectStorageId": {
"type": "string"
},
"upgradeObjectStorageBody": {
"properties": {
"autoScaling": {
"description": "New monthly object storage size limit for autoscaling if enabled.",
"type": "string"
},
"totalPurchasedSpaceTB": {
"description": "New total object storage limit. If this number is larger than before you will also be billed for the added storage space. No downgrade possible.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"objectStorageId",
"upgradeObjectStorageBody"
],
"type": "object"
},
"name": "upgradeObjectStorage",
"outputSchema": null
},
{
"description": "Check domain availablility - Check if a specific domain is available or not",
"inputSchema": {
"properties": {
"domain": {
"type": "string"
},
"x-request-id": {
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"type": "string"
},
"x-trace-id": {
"type": "string"
}
},
"required": [
"x-request-id",
"domain"
],
"type": "object"
},
"name": "validateDomainAvailability",
"outputSchema": null
}
]
}Verify it yourself
curl -s https://api.teppi.xyz/v1/evidence/sha256:ae267edc95e681f20a3d3196ef7da087bb703fab40c01921f1d8d1ea21a1d572 | sha256sum