Servidor MCP

Contabo (VPS) MCP Server

            ai.com.mcp/contabo
        

Nube e infraestructura Público y accesible MCP 2026-07-28

Qué hace este MCP

Provides tools to provision and manage Contabo VPS, bare metal, object storage, networks, DNS, snapshots, images, users, roles, and secrets.

assignInstancePrivateNetwork

Add instance to a Private Network

Add instance to a Private Network - Add a specific instance to a Private Network

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'privateNetworkId', 'instanceId'], 'properties': {'instanceId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'privateNetworkId': {'type': 'integer', 'format': 'int64'}}}

assignIp

Assign a VIP to an VPS/VDS/Bare Metal

Assign a VIP to an VPS/VDS/Bare Metal - Assign a VIP to a VPS/VDS/Bare Metal using the machine id.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'resourceId', 'ip', 'resourceType'], 'properties': {'ip': {'type': 'string'}, 'resourceId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'resourceType': {'enum': ['instances', 'bare-metal'], 'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

bulkDeleteDnsZoneRecords

Bulk delete DNS zone records

Bulk delete DNS zone records - Delete multiple zone records from a DNS Zone

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'zoneName', 'bulkDeleteDnsZoneRecordsBody'], 'properties': {'zoneName': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'bulkDeleteDnsZoneRecordsBody': {'type': 'object', 'required': ['recordIds'], 'properties': {'recordIds': {'type': 'array', 'items': {'type': 'integer', 'format': 'int64'}, 'description': 'List of zone record ids to delete'}}}}}

cancelDomain

Cancel a specific domain

Cancel a specific domain - Cancel a specific domain

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'domain', 'cancelDomainBody'], 'properties': {'domain': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'cancelDomainBody': {'type': 'object', 'properties': {'reason': {'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', 'description': 'Reason for cancelling an domain'}, 'cancelDate': {'type': 'string', 'format': 'date-time', 'description': 'Date of cancellation'}, 'reasonText': {'type': 'string', 'description': 'Reason Text when `Other` reason got selected while cancelling an domain'}}}}}

cancelInstance

Cancel specific instance by id

Cancel specific instance by id - Your are free to cancel a previously created instance at any time.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'instanceId', 'cancelInstanceBody'], 'properties': {'instanceId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'cancelInstanceBody': {'type': 'object', 'properties': {'cancelDate': {'type': 'string', 'format': 'date-time', 'description': 'Date of cancellation'}}}}}

CancelObjectStorage

Cancels the specified object storage at the next possible date

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.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'objectStorageId', 'CancelObjectStorageBody'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'objectStorageId': {'type': 'string'}, 'CancelObjectStorageBody': {'type': 'object', 'properties': {'cancelDate': {'type': 'string', 'format': 'date-time', 'description': 'Date of cancellation'}}}}}

confirmDomainTransferOut

Confirm transfer out for a domain

Confirm transfer out for a domain - Confirm transfer out for a domain

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'domain'], 'properties': {'domain': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

createAssignment

Create a new assignment for the tag

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.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'tagId', 'resourceType', 'resourceId'], 'properties': {'tagId': {'type': 'integer', 'format': 'int64'}, 'resourceId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'resourceType': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

createCustomImage

Provide a custom image

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.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'createCustomImageBody'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'createCustomImageBody': {'type': 'object', 'required': ['name', 'url', 'osType', 'version'], 'properties': {'url': {'type': 'string', 'description': 'URL from where the image has been downloaded / provided.'}, 'name': {'type': 'string', 'description': 'Image Name'}, 'osType': {'enum': ['Windows', 'Linux'], 'type': 'string', '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.'}, 'version': {'type': 'string', 'description': 'Version number to distinguish the contents of an image. Could be the version of the operating system for example.'}, 'description': {'type': 'string', 'description': 'Image Description'}}}}}

createDnsZone

Create DNS zone

Create DNS zone - Creates a new DNS zone for a customer

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'createDnsZoneBody'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'createDnsZoneBody': {'type': 'object', 'required': ['zoneName'], 'properties': {'zoneName': {'type': 'string', 'description': 'Zone name'}}}}}

createDnsZoneRecord

Create DNS zone record

Create DNS zone record - Create resource record in a zone

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'zoneName', 'createDnsZoneRecordBody'], 'properties': {'zoneName': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'createDnsZoneRecordBody': {'type': 'object', 'required': ['type', 'ttl', 'prio', 'data'], 'properties': {'tag': {'type': 'string', 'description': 'Tag'}, 'ttl': {'type': 'number', 'description': 'TTL'}, 'data': {'type': 'string', 'minLength': 1, 'description': 'Data'}, 'flag': {'type': 'number', 'description': 'Flag'}, 'name': {'type': 'string', 'minLength': 1, 'description': 'Name, if empty the zone name will be used'}, 'port': {'type': 'number', 'description': 'Port'}, 'prio': {'type': 'number', 'description': 'Prio'}, 'type': {'type': 'string', 'minLength': 1, 'description': 'Type'}, 'weight': {'type': 'number', 'description': 'Weight'}}}}}

createHandle

Create specific handle

Create specific handle - Create specific handle

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'createHandleBody'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'createHandleBody': {'type': 'object', 'required': ['handleType', 'firstName', 'lastName', 'email', 'gender', 'address', 'phone'], 'properties': {'fax': {'type': 'string', 'description': 'Handle fax'}, 'email': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'Handle email'}, 'phone': {'type': 'string', 'description': 'Handle phone'}, 'gender': {'enum': ['male', 'female', 'na'], 'type': 'string', 'description': 'Handle gender'}, 'address': {'type': 'string', 'description': 'Address details for handle'}, 'lastName': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'Handle last name'}, 'birthInfo': {'type': 'string', 'description': 'The birth info of the handle'}, 'firstName': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'Handle first name'}, 'handleType': {'enum': ['person', 'organization'], 'type': 'string', 'description': 'The type of the handle'}, 'organization': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'The organization of the handle'}}}}}

createInstance

Create a new instance

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>

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'createInstanceBody'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'createInstanceBody': {'type': 'object', 'required': ['period'], 'properties': {'addOns': {'type': 'string', 'description': 'Set attributes in the addons object for the corresponding ones that need to be added to the instance'}, 'period': {'type': 'integer', 'format': 'int64', 'description': 'Initial contract period in months. Available periods are: 1, 3, 6 and 12 months. Default to 1 month'}, 'region': {'enum': ['EU', 'US-central', 'US-east', 'US-west', 'SIN', 'UK', 'AUS', 'JPN', 'IND'], 'type': 'string', 'minLength': 1, 'description': 'Instance Region where the compute instance should be located. Default is EU'}, 'imageId': {'type': 'string', 'description': 'ImageId to be used to setup the compute instance. Default is Ubuntu 22.04'}, 'license': {'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', 'description': 'Additional licence in order to enhance your chosen product, mainly needed for software licenses on your product (not needed for windows).'}, 'sshKeys': {'type': 'array', 'items': {'type': 'integer', 'format': 'int64'}, '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.'}, 'userData': {'type': 'string', 'description': '[Cloud-Init](https://cloud-init.io/) Config in order to customize during start of compute instance.'}, 'productId': {'type': 'string', 'minLength': 1, 'description': 'Default is V92'}, 'defaultUser': {'enum': ['root', 'admin', 'administrator'], 'type': 'string', '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`.'}, 'displayName': {'type': 'string', 'maxLength': 255, 'description': 'The display name of the instance'}, 'rootPassword': {'type': 'integer', 'format': 'int64', '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.'}, 'applicationId': {'type': 'string', 'description': 'Application ID'}}}}}

createObjectStorage

Create a new object storage

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`

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'createObjectStorageBody'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'createObjectStorageBody': {'type': 'object', 'required': ['region', 'totalPurchasedSpaceTB'], 'properties': {'region': {'type': 'string', 'minLength': 1, 'description': 'Region where the object storage should be located. Default is EU. Available regions: EU, US-central, SIN'}, 'autoScaling': {'type': 'string', 'description': 'Autoscaling settings'}, 'displayName': {'type': 'string', 'maxLength': 255, 'minLength': 1, '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.'}, 'totalPurchasedSpaceTB': {'type': 'number', 'format': 'double', 'description': 'Amount of purchased / requested object storage in TB.'}}}}}

createPrivateNetwork

Create a new Private Network

Create a new Private Network - Create a new Private Network in your account.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'createPrivateNetworkBody'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'createPrivateNetworkBody': {'type': 'object', 'required': ['name'], 'properties': {'name': {'type': 'string', 'maxLength': 255, 'minLength': 1, '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.'}, 'region': {'type': 'string', 'minLength': 1, 'description': 'Region where the Private Network should be located. Default is `EU`'}, 'description': {'type': 'string', 'maxLength': 255, 'description': 'The description of the Private Network. There is a limit of 255 characters per Private Network description.'}}}}}

createPtrRecord

Create a new PTR Record using ip address

Create a new PTR Record using ip address - Create a new PTR Record using ip address. Only IPv6 can be created

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'createPtrRecordBody'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'createPtrRecordBody': {'type': 'object', 'required': ['ptr', 'ip', 'ttl'], 'properties': {'ip': {'type': 'string', 'description': 'IP Address'}, 'ptr': {'type': 'string', 'description': 'PTR Record name'}, 'ttl': {'type': 'integer', 'format': 'int64', 'description': 'Time to live for the PTR record in seconds'}}}}}

createRole

Create a new role

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.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'createRoleBody'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'createRoleBody': {'type': 'object', 'required': ['name', 'admin', 'accessAllResources'], 'properties': {'name': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'The name of the role. There is a limit of 255 characters per role.'}, 'admin': {'type': 'boolean', 'description': 'If user is admin he will have permissions to all API endpoints and resources. Enabling this will superseed all role definitions and `accessAllResources`.'}, 'permissions': {'type': 'array', 'items': {'type': 'object', 'required': ['apiName', 'actions'], 'properties': {'actions': {'type': 'array', 'items': {'enum': ['CREATE', 'READ', 'UPDATE', 'DELETE'], 'type': 'string'}, '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.'}, 'apiName': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'The name of the role. There is a limit of 255 characters per role.'}, 'resources': {'type': 'array', 'items': {'type': 'integer', 'format': 'int64'}, '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.'}}}}, 'accessAllResources': {'type': 'boolean', 'description': 'Allow access to all resources. This will superseed all assigned resources in a role.'}}}}}

createSecret

Create a new secret

Create a new secret - Create a new secret in your account with attributes name, type and value. Attribute type can be password or ssh.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'createSecretBody'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'createSecretBody': {'type': 'object', 'required': ['name', 'value', 'type'], 'properties': {'name': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'The name of the secret that will keep the password'}, 'type': {'enum': ['password', 'ssh'], 'type': 'string', 'description': 'The type of the secret. Can be `password` or `ssh`'}, 'value': {'type': 'string', 'minLength': 8, '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,}$`'}}}}}

createSnapshot

Create a new instance snapshot

Create a new instance snapshot - Create a new snapshot for instance, with name and description attributes

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'instanceId', 'createSnapshotBody'], 'properties': {'instanceId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'createSnapshotBody': {'type': 'object', 'required': ['name'], 'properties': {'name': {'type': 'string', 'maxLength': 30, 'minLength': 1, 'description': 'The name of the snapshot. It may contain letters, numbers, spaces, dashes. There is a limit of 30 characters per snapshot.'}, 'description': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'The description of the snapshot. There is a limit of 255 characters per snapshot.'}}}}}

createTag

Create a new tag

Create a new tag - Create a new tag in your account with attribute name and optional attribute color.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'createTagBody'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'createTagBody': {'type': 'object', 'required': ['name', 'color'], 'properties': {'name': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag.'}, 'color': {'type': 'string', 'maxLength': 7, 'minLength': 4, 'description': 'The color of the tag. Color can be specified using hexadecimal value. Default color is #0A78C3'}, 'description': {'type': 'string', 'description': 'The description of the Tag name. '}}}}}

createUser

Create a new user

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.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'createUserBody'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'createUserBody': {'type': 'object', 'required': ['email', 'enabled', 'totp', 'locale'], 'properties': {'totp': {'type': 'boolean', 'description': 'Enable or disable two-factor authentication (2FA) via time based OTP.'}, 'email': {'type': 'string', 'maxLength': 255, 'minLength': 1, '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.'}, 'roles': {'type': 'array', 'items': {'type': 'integer', 'format': 'int64'}, 'description': 'The roles as list of `roleId`s of the user.'}, 'locale': {'enum': ['de-DE', 'de', 'en-US', 'en', 'es', 'es-ES', 'pt-BR', 'pt'], 'type': 'string', 'description': 'The locale of the user. This can be `de-DE`, `de`, `en-US`, `en`, `es-ES`, `es`, `pt-BR`, `pt`.'}, 'enabled': {'type': 'boolean', 'description': "If user is not enabled, he can't login and thus use services any longer."}, 'lastName': {'type': 'string', 'maxLength': 255, 'minLength': 1, '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.'}, 'firstName': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'The name of the user. Names may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per user.'}}}}}

deleteAssignment

Delete existing tag assignment

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.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'tagId', 'resourceType', 'resourceId'], 'properties': {'tagId': {'type': 'integer', 'format': 'int64'}, 'resourceId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'resourceType': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

deleteDnsZone

Delete a DNS zone.

Delete a DNS zone. - Delete a DNS Zone using zone name.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'zoneName'], 'properties': {'zoneName': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

deleteDnsZoneRecord

Delete a DNS zone record

Delete a DNS zone record - Delete a DNZ Zone's record

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'recordId', 'zoneName'], 'properties': {'recordId': {'type': 'integer', 'format': 'int64'}, 'zoneName': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

deleteImage

Delete an uploaded custom image by its id

Delete an uploaded custom image by its id - Your are free to delete a previously uploaded custom images at any time

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'imageId'], 'properties': {'imageId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

deletePrivateNetwork

Delete existing Private Network by id

Delete existing Private Network by id - Delete existing Virtual Private Cloud by id and automatically unassign all instances from it

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'privateNetworkId'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'privateNetworkId': {'type': 'integer', 'format': 'int64'}}}

deletePtrRecord

Delete a PTR Record using ip address

Delete a PTR Record using ip address - Delete a PTR Record using ip address. Only IPv6 can be deleted

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'ipAddress'], 'properties': {'ipAddress': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

deleteRole

Delete existing role by id

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.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'roleId'], 'properties': {'roleId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

deleteSecret

Delete existing secret by id

Delete existing secret by id - You can remove a specific secret from your account.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'secretId'], 'properties': {'secretId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

deleteSnapshot

Delete existing snapshot by id

Delete existing snapshot by id - Delete existing instance snapshot by id

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'instanceId', 'snapshotId'], 'properties': {'instanceId': {'type': 'integer', 'format': 'int64'}, 'snapshotId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

deleteTag

Delete existing tag by id

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.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'tagId'], 'properties': {'tagId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

deleteUser

Delete existing user by id

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.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'userId'], 'properties': {'userId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

generateClientSecret

Generate new client secret

Generate new client secret - Generate and get new client secret.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

getAuthCode

Get auth code for a domain

Get auth code for a domain - Get auth code for a domain by id

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'domain'], 'properties': {'domain': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

getObjectStorageCredentials

Get S3 compatible object storage credentials.

Get S3 compatible object storage credentials. - Get S3 compatible object storage credentials for accessing it via S3 compatible tools like `aws` cli.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'userId', 'objectStorageId', 'credentialId'], 'properties': {'userId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'credentialId': {'type': 'integer', 'format': 'int64'}, 'x-request-id': {'type': 'string', '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}$'}, 'objectStorageId': {'type': 'string'}}}

listDomains

List all domains

List all domains - List and filter all your domains

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'sld': {'type': 'string'}, 'tld': {'type': 'string'}, 'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'status': {'enum': ['ready', 'processing', 'transferring in', 'transferring out', 'manual_task', 'transferred'], 'type': 'string'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

listHandles

List all handles

List all handles - List and filter all your handles

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'name': {'type': 'string'}, 'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'search': {'type': 'string'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'lastName': {'type': 'string'}, 'countries': {'type': 'string'}, 'firstName': {'type': 'string'}, 'handleType': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'showDefaults': {'type': 'boolean'}, 'x-request-id': {'type': 'string', '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}$'}}}

listObjectStorageCredentials

Get list of S3 compatible object storage credentials for user.

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.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'userId'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'userId': {'type': 'string'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'regionName': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'displayName': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'objectStorageId': {'type': 'string'}}}

orderDomain

Create or transfer a domain

Create or transfer a domain - Create or transfer a domain

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'orderDomainBody'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'orderDomainBody': {'type': 'object', 'required': ['domain', 'handles', 'nameservers'], 'properties': {'domain': {'type': 'string', 'description': 'Domain name'}, 'handles': {'type': 'string', 'description': 'The handles of the domain'}, 'authCode': {'type': 'string', 'description': 'The domain auth code'}, 'resourceId': {'type': 'string', 'description': 'The identifier of the resource id'}, 'nameservers': {'type': 'array', 'items': {'type': 'object', 'required': ['hostname'], 'properties': {'ipV4': {'type': 'array', 'items': {'type': 'string'}, 'description': 'IPv4 of nameserver'}, 'ipV6': {'type': 'array', 'items': {'type': 'string'}, 'description': 'IPv6 of nameserver'}, 'hostname': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Nameservers'}}}, 'description': 'Nameservers'}, 'resourceType': {'enum': ['instance', 'server', 'package'], 'type': 'string', 'description': 'The identifier of the resource type'}}}}}

patchInstance

Update specific instance

Update specific instance - Update specific instance by instanceId.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'instanceId', 'patchInstanceBody'], 'properties': {'instanceId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'patchInstanceBody': {'type': 'object', 'properties': {'displayName': {'type': 'string', 'maxLength': 255, 'description': 'The display name of the instance'}}}}}

patchPrivateNetwork

Update a Private Network by id

Update a Private Network by id - Update a Private Network by id in your account.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'privateNetworkId', 'patchPrivateNetworkBody'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'privateNetworkId': {'type': 'integer', 'format': 'int64'}, 'patchPrivateNetworkBody': {'type': 'object', 'properties': {'name': {'type': 'string', 'maxLength': 255, 'minLength': 1, '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.'}, 'description': {'type': 'string', 'maxLength': 255, 'description': 'The description of the Private Network. There is a limit of 255 characters per Private Network.'}}}}}

regenerateObjectStorageCredentials

Regenerates secret key of specified user for the S3 compatible object storages.

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.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'userId', 'objectStorageId', 'credentialId'], 'properties': {'userId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'credentialId': {'type': 'integer', 'format': 'int64'}, 'x-request-id': {'type': 'string', '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}$'}, 'objectStorageId': {'type': 'string'}}}

reinstallInstance

Reinstall specific instance

Reinstall specific instance - You can reinstall a specific instance with a new image and optionally add ssh keys, a root password or cloud-init.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'instanceId', 'reinstallInstanceBody'], 'properties': {'instanceId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'reinstallInstanceBody': {'type': 'object', 'required': ['imageId'], 'properties': {'imageId': {'type': 'string', 'description': 'ImageId to be used to setup the compute instance.'}, 'sshKeys': {'type': 'array', 'items': {'type': 'integer', 'format': 'int64'}, '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.'}, 'userData': {'type': 'string', 'description': '[Cloud-Init](https://cloud-init.io/) Config in order to customize during start of compute instance.'}, 'defaultUser': {'enum': ['root', 'admin', 'administrator'], 'type': 'string', '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`.'}, 'rootPassword': {'type': 'integer', 'format': 'int64', '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.'}, 'applicationId': {'type': 'string', 'description': 'Application ID'}}}}}

removeHandle

Remove specific handle

Remove specific handle - Remove specific handle

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'handleId'], 'properties': {'handleId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

rescue

Rescue a compute instance / resource identified by its id

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.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'instanceId', 'rescueBody'], 'properties': {'instanceId': {'type': 'integer', 'format': 'int64'}, 'rescueBody': {'type': 'object', 'properties': {'sshKeys': {'type': 'array', 'items': {'type': 'integer', 'format': 'int64'}, 'description': 'Array of `secretId`s of public SSH keys for logging into rescue system as `root` user.'}, 'userData': {'type': 'string', 'description': '[Cloud-Init](https://cloud-init.io/) Config in order to customize during start of compute instance.'}, 'rootPassword': {'type': 'integer', 'format': 'int64', 'description': '`secretId` of the password to login into rescue system for the `root` user.'}}}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

resendEmailVerification

Resend email verification

Resend email verification - Resend email verification for a specific user

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'userId'], 'properties': {'userId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'redirectUrl': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

resetPassword

Send reset password email

Send reset password email - Send reset password email for a specific user

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'userId'], 'properties': {'userId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'redirectUrl': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

resetPasswordAction

Reset password for a compute instance / resource referenced by an id

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.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'instanceId', 'resetPasswordActionBody'], 'properties': {'instanceId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'resetPasswordActionBody': {'type': 'object', 'properties': {'sshKeys': {'type': 'array', 'items': {'type': 'integer', 'format': 'int64'}, '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.'}, 'userData': {'type': 'string', 'description': '[Cloud-Init](https://cloud-init.io/) Config in order to customize during start of compute instance.'}, 'rootPassword': {'type': 'integer', 'format': 'int64', '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.'}}}}}

restart

Restart a compute instance / resource identified by its id.

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.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'instanceId'], 'properties': {'instanceId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveApiPermissionsList

List of API permissions

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.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'apiName': {'type': 'string'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveAssignment

Get specific assignment for the tag

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.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'tagId', 'resourceType', 'resourceId'], 'properties': {'tagId': {'type': 'integer', 'format': 'int64'}, 'resourceId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'resourceType': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveAssignmentList

List tag assignments

List tag assignments - List and filter all existing assignments for a tag in your account

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'tagId'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'tagId': {'type': 'integer', 'format': 'int64'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'x-trace-id': {'type': 'string'}, 'resourceType': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveAssignmentsAuditsList

List history about your assignments (audit)

List history about your assignments (audit) - List and filters the history about your assignments.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'tagId': {'type': 'integer', 'format': 'int64'}, 'endDate': {'type': 'string', 'format': 'date'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'changedBy': {'type': 'string'}, 'requestId': {'type': 'string'}, 'startDate': {'type': 'string', 'format': 'date'}, 'resourceId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveCustomImagesStats

List statistics regarding the customer's custom images

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

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveDataCenterList

List data centers

List data centers - List all data centers and their corresponding regions.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'name': {'type': 'string', 'minLength': 1}, 'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'slug': {'type': 'string', 'minLength': 1}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'regionName': {'type': 'string', 'minLength': 1}, 'regionSlug': {'type': 'string', 'minLength': 1}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveDnsZone

Retrieve a DNS Zone by zone name

Retrieve a DNS Zone by zone name - Get all attributes for a specific DNS Zone

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'zoneName'], 'properties': {'zoneName': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveDnsZoneRecordsList

List a DNS Zone's records

List a DNS Zone's records - Get all the records of a DNS Zone

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'zoneName'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'search': {'type': 'string'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'zoneName': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveDnsZonesList

List DNS zones

List DNS zones - Get a list of all zones

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'tenantId': {'enum': ['DE', 'INT'], 'type': 'string'}, 'zoneName': {'type': 'string'}, 'customerId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveDomain

List specific domain

List specific domain - List specific domain

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'domain'], 'properties': {'domain': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveDomainsAuditsList

List history about your Domains (audit)

List history about your Domains (audit) - List and filters the history about your Domains.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'domain': {'type': 'string'}, 'endDate': {'type': 'string', 'format': 'date'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'changedBy': {'type': 'string'}, 'requestId': {'type': 'string'}, 'startDate': {'type': 'string', 'format': 'date'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveHandle

Get specific handle

Get specific handle - Get specific handle

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'handleId'], 'properties': {'handleId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveHandlesAuditsList

List history about your handles (audit)

List history about your handles (audit) - List and filters the history about your handles.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'endDate': {'type': 'string', 'format': 'date'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'handleId': {'type': 'string'}, 'changedBy': {'type': 'string'}, 'requestId': {'type': 'string'}, 'startDate': {'type': 'string', 'format': 'date'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveImage

Get details about a specific image by its id

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

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'imageId'], 'properties': {'imageId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveImageAuditsList

List history about your DNS Zones (audit)

List history about your DNS Zones (audit) - List and filters the history about your DNS Zones .

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'name': {'type': 'string'}, 'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'endDate': {'type': 'string', 'format': 'date'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'changedBy': {'type': 'string'}, 'requestId': {'type': 'string'}, 'startDate': {'type': 'string', 'format': 'date'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveImageAuditsList1

List history about your custom images (audit)

List history about your custom images (audit) - List and filters the history about your custom images.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'endDate': {'type': 'string', 'format': 'date'}, 'imageId': {'type': 'string'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'changedBy': {'type': 'string'}, 'requestId': {'type': 'string'}, 'startDate': {'type': 'string', 'format': 'date'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveImageList

List available standard and custom images

List available standard and custom images - List and filter all available standard images provided by [Contabo](https://contabo.com) and your uploaded custom images.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'name': {'type': 'string'}, 'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'search': {'type': 'string'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'standardImage': {'type': 'boolean'}}}

retrieveInstance

Get specific instance by id

Get specific instance by id - Get attributes values to a specific instance on your account.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'instanceId'], 'properties': {'instanceId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveInstancesActionsAuditsList

List history about your actions (audit) triggered via the API

List history about your actions (audit) triggered via the API - List and filters the history about your actions your triggered via the API.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'endDate': {'type': 'string', 'format': 'date'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'changedBy': {'type': 'string'}, 'requestId': {'type': 'string'}, 'startDate': {'type': 'string', 'format': 'date'}, 'instanceId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveInstancesAuditsList

List history about your instances (audit)

List history about your instances (audit) - List and filters the history about your instances.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'endDate': {'type': 'string', 'format': 'date'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'changedBy': {'type': 'string'}, 'requestId': {'type': 'string'}, 'startDate': {'type': 'string', 'format': 'date'}, 'instanceId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveInstancesList

List instances

List instances - List and filter all instances in your account

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'name': {'type': 'string'}, 'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'region': {'type': 'string'}, 'search': {'type': 'string'}, 'status': {'enum': ['provisioning', 'uninstalled', 'running', 'stopped', 'error', 'installing', 'unknown', 'manual_provisioning', 'product_not_available', 'verification_required', 'rescue', 'pending_payment', 'other', 'reset_password'], 'type': 'string'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'addOnIds': {'type': 'string'}, 'ipConfig': {'type': 'boolean'}, 'tenantId': {'type': 'string'}, 'customerId': {'type': 'string'}, 'dataCenter': {'type': 'string'}, 'instanceId': {'type': 'integer', 'format': 'int64'}, 'productIds': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'displayName': {'type': 'string'}, 'instanceIds': {'type': 'string'}, 'productTypes': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveObjectStorage

Get specific object storage by its id

Get specific object storage by its id - Get data for a specific object storage on your account.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'objectStorageId'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'objectStorageId': {'type': 'string'}}}

retrieveObjectStorageAuditsList

List history about your object storages (audit)

List history about your object storages (audit) - List and filters the history about your object storages.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'endDate': {'type': 'string', 'format': 'date'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'changedBy': {'type': 'string'}, 'requestId': {'type': 'string'}, 'startDate': {'type': 'string', 'format': 'date'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'objectStorageId': {'type': 'string'}}}

retrieveObjectStorageList

List all your object storages

List all your object storages - List and filter all object storages in your account

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'region': {'type': 'string'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 's3TenantId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'displayName': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'dataCenterName': {'type': 'string', 'minLength': 1}}}

retrieveObjectStoragesStats

List usage statistics about the specified object storage

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.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'objectStorageId'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'objectStorageId': {'type': 'string'}}}

retrievePrivateNetwork

Get specific Private Network by id

Get specific Private Network by id - Get attributes values to a specific Private Network on your account.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'privateNetworkId'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'privateNetworkId': {'type': 'integer', 'format': 'int64'}}}

retrievePrivateNetworkAuditsList

List history about your Private Networks (audit)

List history about your Private Networks (audit) - List and filters the history about your Private Networks.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'endDate': {'type': 'string', 'format': 'date'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'changedBy': {'type': 'string'}, 'requestId': {'type': 'string'}, 'startDate': {'type': 'string', 'format': 'date'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'privateNetworkId': {'type': 'integer', 'format': 'int64'}}}

retrievePrivateNetworkList

List Private Networks

List Private Networks - List and filter all Private Networks in your account

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'name': {'type': 'string'}, 'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'region': {'type': 'string'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'dataCenter': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'instanceIds': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrievePtrRecord

Retrieve a PTR Record by ip address

Retrieve a PTR Record by ip address - Get all attributes for a specific PTR Record

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'ipAddress'], 'properties': {'ipAddress': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrievePtrRecordsList

List PTR records

List PTR records - Get a list of all PTR records, either customer or a list of IPs is required

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'ips': {'type': 'array', 'items': {'type': 'string'}}, 'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'search': {'type': 'string'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'tenantId': {'enum': ['DE', 'INT'], 'type': 'string'}, 'customerId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveRecordAuditsList

List history about your DNS Records (audit)

List history about your DNS Records (audit) - List and filter the history of changes made to your DNS Records.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'endDate': {'type': 'string', 'format': 'date'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'recordId': {'type': 'integer', 'format': 'int64'}, 'changedBy': {'type': 'string'}, 'requestId': {'type': 'string'}, 'startDate': {'type': 'string', 'format': 'date'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveRole

Get specific role by id

Get specific role by id - Get attributes of specific role.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'roleId'], 'properties': {'roleId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveRoleAuditsList

List history about your roles (audit)

List history about your roles (audit) - List and filter the history about your roles.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'roleId': {'type': 'integer', 'format': 'int64'}, 'endDate': {'type': 'string', 'format': 'date'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'changedBy': {'type': 'string'}, 'requestId': {'type': 'string'}, 'startDate': {'type': 'string', 'format': 'date'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveRoleList

List roles

List roles - List and filter all your roles. A role allows you to specify permission to api endpoints and resources like compute.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'name': {'type': 'string'}, 'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'type': {'type': 'string'}, 'apiName': {'type': 'string'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'tagName': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveSecret

Get specific secret by id

Get specific secret by id - Get attributes values for a specific secret on your account.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'secretId'], 'properties': {'secretId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveSecretAuditsList

List history about your secrets (audit)

List history about your secrets (audit) - List and filters the history about your secrets.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'endDate': {'type': 'string', 'format': 'date'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'secretId': {'type': 'integer', 'format': 'int64'}, 'changedBy': {'type': 'string'}, 'requestId': {'type': 'string'}, 'startDate': {'type': 'string', 'format': 'date'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveSecretList

List secrets

List secrets - List and filter all secrets in your account.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'name': {'type': 'string'}, 'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'type': {'enum': ['password', 'ssh'], 'type': 'string'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveSnapshot

Retrieve a specific snapshot by id

Retrieve a specific snapshot by id - Get all attributes for a specific snapshot

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'instanceId', 'snapshotId'], 'properties': {'instanceId': {'type': 'integer', 'format': 'int64'}, 'snapshotId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveSnapshotList

List snapshots

List snapshots - List and filter all your snapshots for a specific instance

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'instanceId'], 'properties': {'name': {'type': 'string'}, 'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'instanceId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveSnapshotsAuditsList

List history about your snapshots (audit) triggered via the API

List history about your snapshots (audit) triggered via the API - List and filters the history about your snapshots your triggered via the API.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'endDate': {'type': 'string', 'format': 'date'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'changedBy': {'type': 'string'}, 'requestId': {'type': 'string'}, 'startDate': {'type': 'string', 'format': 'date'}, 'instanceId': {'type': 'integer', 'format': 'int64'}, 'snapshotId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveTag

Get specific tag by id

Get specific tag by id - Get attributes values to a specific tag on your account.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'tagId'], 'properties': {'tagId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveTagAuditsList

List history about your assignments (audit)

List history about your assignments (audit) - List and filters the history about your assignments.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'tagId': {'type': 'integer', 'format': 'int64'}, 'endDate': {'type': 'string', 'format': 'date'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'changedBy': {'type': 'string'}, 'requestId': {'type': 'string'}, 'startDate': {'type': 'string', 'format': 'date'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveTagList

List tags

List tags - List and filter all tags in your account

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'name': {'type': 'string'}, 'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveUser

Get specific user by id

Get specific user by id - Get attributes for a specific user.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'userId'], 'properties': {'userId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveUserAuditsList

List history about your users (audit)

List history about your users (audit) - List and filter the history about your users.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'userId': {'type': 'string'}, 'endDate': {'type': 'string', 'format': 'date'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'changedBy': {'type': 'string'}, 'requestId': {'type': 'string'}, 'startDate': {'type': 'string', 'format': 'date'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveUserClient

Get client

Get client - Get idm client.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveUserIsPasswordSet

Get user is password set status

Get user is password set status - Get info about idm user if the password is set.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'userId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveUserList

List users

List users - List and filter all your users.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'email': {'type': 'string'}, 'owner': {'type': 'boolean'}, 'enabled': {'type': 'boolean'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveVip

Get specific VIP by ip

Get specific VIP by ip - Get attributes values to a specific VIP on your account.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'ip'], 'properties': {'ip': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveVipAuditsList

List history about your VIPs (audit)

List history about your VIPs (audit) - List and filters the history about your VIPs.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'vipId': {'type': 'string'}, 'endDate': {'type': 'string', 'format': 'date'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'changedBy': {'type': 'string'}, 'requestId': {'type': 'string'}, 'startDate': {'type': 'string', 'format': 'date'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

retrieveVipList

List VIPs

List VIPs - List and filter all vips in your account

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['x-request-id'], 'properties': {'ip': {'type': 'string'}, 'ips': {'type': 'string'}, 'page': {'type': 'integer', 'format': 'int64'}, 'size': {'type': 'integer', 'format': 'int64'}, 'type': {'enum': ['additional', 'floating'], 'type': 'string'}, 'region': {'type': 'string'}, 'orderBy': {'type': 'array', 'items': {'type': 'string'}}, 'ipVersion': {'enum': ['v4'], 'type': 'string'}, 'dataCenter': {'type': 'string'}, 'resourceId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'resourceName': {'type': 'string'}, 'resourceType': {'enum': ['instances', 'bare-metal', 'null'], 'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'resourceDisplayName': {'type': 'string'}}}

revokeCancelDomain

Revoke cancellation for a specific domain

Revoke cancellation for a specific domain - Revoke cancellation for a specific domain

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'domain'], 'properties': {'domain': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

revokeDomainTransferOut

Revoke transfer out for a domain

Revoke transfer out for a domain - Revoke transfer out for a domain

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'domain'], 'properties': {'domain': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

rollbackSnapshot

Revert the instance to a particular snapshot based on its identifier

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

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'instanceId', 'snapshotId', 'rollbackSnapshotBody'], 'properties': {'instanceId': {'type': 'integer', 'format': 'int64'}, 'snapshotId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'rollbackSnapshotBody': {'type': 'object', 'properties': {}}}}

setDefaultHandle

Set default handle

Set default handle - Set default handle

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'handleId'], 'properties': {'handleId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

shutdown

Shutdown compute instance / resource by its id

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.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'instanceId'], 'properties': {'instanceId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

start

Start a compute instance / resource identified by its id

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.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'instanceId'], 'properties': {'instanceId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

stop

Stop compute instance / resource by its id

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.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'instanceId'], 'properties': {'instanceId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

tool_search

Tool Search

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.

Solo lectura

Esquema de entrada

{'type': 'object', 'required': ['query'], 'properties': {'mode': {'enum': ['regex', 'bm25'], 'type': 'string', 'description': 'Search mode: "regex" for pattern matching, "bm25" for natural language. Defaults to "bm25".'}, 'query': {'type': 'string', 'description': 'A regex pattern or natural-language query to search tool names, descriptions, and argument names. Maximum 200 characters.'}}}

unassignInstancePrivateNetwork

Remove instance from a Private Network

Remove instance from a Private Network - Remove a specific instance from a Private Network

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'privateNetworkId', 'instanceId'], 'properties': {'instanceId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'privateNetworkId': {'type': 'integer', 'format': 'int64'}}}

unassignIp

Unassign a VIP to a VPS/VDS/Bare Metal

Unassign a VIP to a VPS/VDS/Bare Metal - Unassign a VIP from an VPS/VDS/Bare Metal using the machine id.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'resourceId', 'ip', 'resourceType'], 'properties': {'ip': {'type': 'string'}, 'resourceId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'resourceType': {'enum': ['instances', 'bare-metal'], 'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

updateDnsZoneRecord

Update DNS zone record

Update DNS zone record - Create resource record in a zone

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'recordId', 'zoneName', 'updateDnsZoneRecordBody'], 'properties': {'recordId': {'type': 'integer', 'format': 'int64'}, 'zoneName': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'updateDnsZoneRecordBody': {'type': 'object', 'required': ['ttl', 'prio', 'data'], 'properties': {'tag': {'type': 'string', 'description': 'Tag'}, 'ttl': {'type': 'number', 'description': 'TTL'}, 'data': {'type': 'string', 'minLength': 1, 'description': 'Data'}, 'flag': {'type': 'number', 'description': 'Flag'}, 'port': {'type': 'number', 'description': 'Port'}, 'prio': {'type': 'number', 'description': 'Prio'}, 'weight': {'type': 'number', 'description': 'Weight'}}}}}

updateDomain

Update a specific domain

Update a specific domain - Update nameservers and handles for a specific domain

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'domain', 'updateDomainBody'], 'properties': {'domain': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'updateDomainBody': {'type': 'object', 'properties': {'handles': {'type': 'string', 'description': 'The handles of the domain'}, 'nameservers': {'type': 'array', 'items': {'type': 'object', 'required': ['hostname'], 'properties': {'ipV4': {'type': 'array', 'items': {'type': 'string'}, 'description': 'IPv4 of nameserver'}, 'ipV6': {'type': 'array', 'items': {'type': 'string'}, 'description': 'IPv6 of nameserver'}, 'hostname': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Nameservers'}}}, 'description': 'Nameservers'}}}}}

updateHandle

Update specific handle

Update specific handle - Update specific handle

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'handleId', 'updateHandleBody'], 'properties': {'handleId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'updateHandleBody': {'type': 'object', 'required': ['email', 'gender', 'address', 'phone'], 'properties': {'fax': {'type': 'string', 'description': 'Handle fax'}, 'email': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'Handle email'}, 'phone': {'type': 'string', 'description': 'Handle phone'}, 'gender': {'enum': ['male', 'female', 'na'], 'type': 'string', 'description': 'Handle gender'}, 'address': {'type': 'string', 'description': 'Address details for handle'}, 'birthInfo': {'type': 'string', 'description': 'The birth info of the handle'}}}}}

updateImage

Update custom image name by its id

Update custom image name by its id - Update name of the custom image

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'imageId', 'updateImageBody'], 'properties': {'imageId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'updateImageBody': {'type': 'object', 'properties': {'name': {'type': 'string', 'description': 'Image Name'}, 'description': {'type': 'string', 'description': 'Image Description'}}}}}

updateObjectStorage

Modifies the display name of object storage

Modifies the display name of object storage - Modifies the display name of object storage. Display name must be unique.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'objectStorageId', 'updateObjectStorageBody'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'objectStorageId': {'type': 'string'}, 'updateObjectStorageBody': {'type': 'object', 'required': ['displayName'], 'properties': {'displayName': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'Display name helps to differentiate between object storages, especially if they are in the same region.'}}}}}

updatePtrRecord

Edit a PTR Record by ip address

Edit a PTR Record by ip address - Edit attributes for a specific PTR Record

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'ipAddress', 'updatePtrRecordBody'], 'properties': {'ipAddress': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'updatePtrRecordBody': {'type': 'object', 'required': ['ptr'], 'properties': {'ptr': {'type': 'string', 'description': 'PTR Record name'}}}}}

updateRole

Update specific role by id

Update specific role by id - Update attributes to your role. Attributes are optional. If not set, the attributes will retain their original values.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'roleId', 'updateRoleBody'], 'properties': {'roleId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'updateRoleBody': {'type': 'object', 'required': ['name', 'admin', 'accessAllResources'], 'properties': {'name': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'The name of the role. There is a limit of 255 characters per role.'}, 'admin': {'type': 'boolean', 'description': 'If user is admin he will have permissions to all API endpoints and resources. Enabling this will superseed all role definitions and `accessAllResources`.'}, 'permissions': {'type': 'array', 'items': {'type': 'object', 'required': ['apiName', 'actions'], 'properties': {'actions': {'type': 'array', 'items': {'enum': ['CREATE', 'READ', 'UPDATE', 'DELETE'], 'type': 'string'}, '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.'}, 'apiName': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'The name of the role. There is a limit of 255 characters per role.'}, 'resources': {'type': 'array', 'items': {'type': 'integer', 'format': 'int64'}, '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.'}}}}, 'accessAllResources': {'type': 'boolean', 'description': 'Allow access to all resources. This will superseed all assigned resources in a role.'}}}}}

updateSecret

Update specific secret by id

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.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'secretId', 'updateSecretBody'], 'properties': {'secretId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'updateSecretBody': {'type': 'object', 'properties': {'name': {'type': 'string', 'description': 'The name of the secret to be saved'}, 'value': {'type': 'string', 'minLength': 8, 'description': 'The value of the secret to be saved'}}}}}

updateSnapshot

Update specific snapshot by id

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.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'instanceId', 'snapshotId', 'updateSnapshotBody'], 'properties': {'instanceId': {'type': 'integer', 'format': 'int64'}, 'snapshotId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'updateSnapshotBody': {'type': 'object', 'properties': {'name': {'type': 'string', 'maxLength': 30, 'minLength': 1, 'description': 'The name of the snapshot. Tags may contain only letters, numbers, spaces, dashes. There is a limit of 30 characters per snapshot.'}, 'description': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'The description of the snapshot. There is a limit of 255 characters per snapshot.'}}}}}

updateTag

Update specific tag by id

Update specific tag by id - Update attributes to your tag. Attributes are optional. If not set, the attributes will retain their original values.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'tagId', 'updateTagBody'], 'properties': {'tagId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'updateTagBody': {'type': 'object', 'properties': {'name': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag.'}, 'color': {'type': 'string', 'maxLength': 7, 'minLength': 4, 'description': 'The color of the tag. Color can be specified using hexadecimal value. Default color is #0A78C3'}, 'description': {'type': 'string', 'description': 'The description of the Tag name. '}}}}}

updateUser

Update specific user by id

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.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'userId', 'updateUserBody'], 'properties': {'userId': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'updateUserBody': {'type': 'object', 'properties': {'totp': {'type': 'boolean', 'description': 'Enable or disable two-factor authentication (2FA) via time based OTP.'}, 'email': {'type': 'string', 'maxLength': 255, 'minLength': 1, '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.'}, 'roles': {'type': 'array', 'items': {'type': 'integer', 'format': 'int64'}, 'description': 'The roles as list of `roleId`s of the user.'}, 'locale': {'enum': ['de-DE', 'de', 'en-US', 'en', 'es', 'es-ES', 'pt-BR', 'pt'], 'type': 'string', 'description': 'The locale of the user. This can be `de-DE`, `de`, `en-US`, `en`, `es-ES`, `es`, `pt-BR`, `pt`.'}, 'enabled': {'type': 'boolean', 'description': "If user is not enabled, he can't login and thus use services any longer."}, 'lastName': {'type': 'string', 'maxLength': 255, 'minLength': 1, '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.'}, 'firstName': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'The name of the user. Names may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per user.'}}}}}

upgradeInstance

Upgrading instance capabilities

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.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'instanceId', 'upgradeInstanceBody'], 'properties': {'instanceId': {'type': 'integer', 'format': 'int64'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'upgradeInstanceBody': {'type': 'object', 'properties': {'backup': {'type': 'string', '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.'}, 'privateNetworking': {'type': 'string', '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.'}}}}}

upgradeObjectStorage

Upgrade object storage size resp. update autoscaling settings.

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.

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'objectStorageId', 'upgradeObjectStorageBody'], 'properties': {'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}, 'objectStorageId': {'type': 'string'}, 'upgradeObjectStorageBody': {'type': 'object', 'properties': {'autoScaling': {'type': 'string', 'description': 'New monthly object storage size limit for autoscaling if enabled.'}, 'totalPurchasedSpaceTB': {'type': 'number', 'format': 'double', '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.'}}}}}

validateDomainAvailability

Check domain availablility

Check domain availablility - Check if a specific domain is available or not

Destructivo

Esquema de entrada

{'type': 'object', 'required': ['x-request-id', 'domain'], 'properties': {'domain': {'type': 'string'}, 'x-trace-id': {'type': 'string'}, 'x-request-id': {'type': 'string', '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}$'}}}

Añadido

                            retrieveObjectStorageAuditsList
                        

11 de September de 2026 a las 15:33

Añadido

                            CancelObjectStorage
                        

11 de September de 2026 a las 15:33

Añadido

                            retrieveObjectStoragesStats
                        

11 de September de 2026 a las 15:33

Añadido

                            upgradeObjectStorage
                        

11 de September de 2026 a las 15:33

Añadido

                            updateObjectStorage
                        

11 de September de 2026 a las 15:33

Añadido

                            retrieveObjectStorage
                        

11 de September de 2026 a las 15:33

Añadido

                            retrieveDataCenterList
                        

11 de September de 2026 a las 15:33

Añadido

                            createObjectStorage
                        

11 de September de 2026 a las 15:33

Añadido

                            retrieveObjectStorageList
                        

11 de September de 2026 a las 15:33

Añadido

                            retrieveDomainsAuditsList
                        

11 de September de 2026 a las 15:33

Añadido

                            retrieveHandlesAuditsList
                        

11 de September de 2026 a las 15:33

Añadido

                            revokeDomainTransferOut
                        

11 de September de 2026 a las 15:33

Añadido

                            confirmDomainTransferOut
                        

11 de September de 2026 a las 15:33

Añadido

                            revokeCancelDomain
                        

11 de September de 2026 a las 15:33

Añadido

                            getAuthCode
                        

11 de September de 2026 a las 15:33

Añadido

                            cancelDomain
                        

11 de September de 2026 a las 15:33

Añadido

                            updateDomain
                        

11 de September de 2026 a las 15:33

Añadido

                            retrieveDomain
                        

11 de September de 2026 a las 15:33

Añadido

                            orderDomain
                        

11 de September de 2026 a las 15:33

Añadido

                            listDomains
                        

11 de September de 2026 a las 15:33

Añadido

                            validateDomainAvailability
                        

11 de September de 2026 a las 15:33

Añadido

                            setDefaultHandle
                        

11 de September de 2026 a las 15:33

Añadido

                            updateHandle
                        

11 de September de 2026 a las 15:33

Añadido

                            removeHandle
                        

11 de September de 2026 a las 15:33

Añadido

                            retrieveHandle
                        

11 de September de 2026 a las 15:33

Añadido

                            createHandle
                        

11 de September de 2026 a las 15:33

Añadido

                            listHandles
                        

11 de September de 2026 a las 15:33

Añadido

                            retrieveSnapshotsAuditsList
                        

11 de September de 2026 a las 15:33

Añadido

                            retrieveImageAuditsList1
                        

11 de September de 2026 a las 15:33

Añadido

                            rollbackSnapshot
                        

11 de September de 2026 a las 15:33

Detalles del servidor

Versión

0.6.0

Transporte

Streamable HTTP

Herramientas

124

Latencia

618 ms

Último escaneo

1 de October de 2026 a las 02:51

Detectado por primera vez

11 de September de 2026 a las 15:27

Endpoint

https://contabo.run.mcp.com.ai/mcp

Escaneos recientes

Correcto

1 de October de 2026 a las 02:51

Correcto

29 de September de 2026 a las 03:00

Correcto

27 de September de 2026 a las 02:51

Correcto

25 de September de 2026 a las 03:00

Correcto

23 de September de 2026 a las 02:51

Correcto

21 de September de 2026 a las 02:58

Correcto

19 de September de 2026 a las 02:49

Correcto

17 de September de 2026 a las 12:56

Correcto

17 de September de 2026 a las 02:44

Correcto

16 de September de 2026 a las 02:43

Correcto

15 de September de 2026 a las 02:43

Correcto

14 de September de 2026 a las 02:43

Correcto

13 de September de 2026 a las 02:43

Correcto

11 de September de 2026 a las 15:33

Contabo (VPS) MCP Server

Qué hace este MCP

Herramientas

Cambios recientes en herramientas

Servidores MCP similares

BorealHost

Algenta MCP Server

mcphost

shiply

OSIR Domain Registrar

Fine Structure

mcp

BlackVeil DNS & Email Security Scanner