retrieveAssignmentList
List tag assignments - List and filter all existing assignments for a tag in your account
retrieveAssignment
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.
createAssignment
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.
deleteAssignment
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.
retrieveTagAuditsList
List history about your assignments (audit) - List and filters the history about your assignments.
retrieveAssignmentsAuditsList
List history about your assignments (audit) - List and filters the history about your assignments.
retrievePtrRecord
Retrieve a PTR Record by ip address - Get all attributes for a specific PTR Record
updatePtrRecord
Edit a PTR Record by ip address - Edit attributes for a specific PTR Record
deletePtrRecord
Delete a PTR Record using ip address - Delete a PTR Record using ip address. Only IPv6 can be deleted
createPtrRecord
Create a new PTR Record using ip address - Create a new PTR Record using ip address. Only IPv6 can be created
retrievePtrRecordsList
List PTR records - Get a list of all PTR records, either customer or a list of IPs is required
retrieveDnsZonesList
List DNS zones - Get a list of all zones
createDnsZone
Create DNS zone - Creates a new DNS zone for a customer
retrieveDnsZone
Retrieve a DNS Zone by zone name - Get all attributes for a specific DNS Zone
deleteDnsZone
Delete a DNS zone. - Delete a DNS Zone using zone name.
retrieveDnsZoneRecordsList
List a DNS Zone's records - Get all the records of a DNS Zone
createDnsZoneRecord
Create DNS zone record - Create resource record in a zone
updateDnsZoneRecord
Update DNS zone record - Create resource record in a zone
deleteDnsZoneRecord
Delete a DNS zone record - Delete a DNZ Zone's record
bulkDeleteDnsZoneRecords
Bulk delete DNS zone records - Delete multiple zone records from a DNS Zone
retrieveImageAuditsList
List history about your DNS Zones (audit) - List and filters the history about your DNS Zones .
retrieveRecordAuditsList
List history about your DNS Records (audit) - List and filter the history of changes made to your DNS Records.
retrieveVipList
List VIPs - List and filter all vips in your account
retrieveVip
Get specific VIP by ip - Get attributes values to a specific VIP on your account.
assignIp
Assign a VIP to an VPS/VDS/Bare Metal - Assign a VIP to a VPS/VDS/Bare Metal using the machine id.
unassignIp
Unassign a VIP to a VPS/VDS/Bare Metal - Unassign a VIP from an VPS/VDS/Bare Metal using the machine id.
retrieveVipAuditsList
List history about your VIPs (audit) - List and filters the history about your VIPs.
retrieveSecretList
List secrets - List and filter all secrets in your account.
createSecret
Create a new secret - Create a new secret in your account with attributes name, type and value. Attribute type can be password or ssh.
retrieveSecret
Get specific secret by id - Get attributes values for a specific secret on your account.
updateSecret
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.
deleteSecret
Delete existing secret by id - You can remove a specific secret from your account.
retrieveSecretAuditsList
List history about your secrets (audit) - List and filters the history about your secrets.
retrievePrivateNetworkList
List Private Networks - List and filter all Private Networks in your account
createPrivateNetwork
Create a new Private Network - Create a new Private Network in your account.
patchPrivateNetwork
Update a Private Network by id - Update a Private Network by id in your account.
retrievePrivateNetwork
Get specific Private Network by id - Get attributes values to a specific Private Network on your account.
deletePrivateNetwork
Delete existing Private Network by id - Delete existing Virtual Private Cloud by id and automatically unassign all instances from it
assignInstancePrivateNetwork
Add instance to a Private Network - Add a specific instance to a Private Network
unassignInstancePrivateNetwork
Remove instance from a Private Network - Remove a specific instance from a Private Network
retrievePrivateNetworkAuditsList
List history about your Private Networks (audit) - List and filters the history about your Private Networks.
retrieveUserList
List users - List and filter all your users.
createUser
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.
retrieveUser
Get specific user by id - Get attributes for a specific user.
updateUser
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.
deleteUser
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.
resetPassword
Send reset password email - Send reset password email for a specific user
resendEmailVerification
Resend email verification - Resend email verification for a specific user
retrieveUserClient
Get client - Get idm client.
generateClientSecret
Generate new client secret - Generate and get new client secret.
retrieveUserIsPasswordSet
Get user is password set status - Get info about idm user if the password is set.
retrieveRoleList
List roles - List and filter all your roles. A role allows you to specify permission to api endpoints and resources like compute.
createRole
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.
retrieveRole
Get specific role by id - Get attributes of specific role.
updateRole
Update specific role by id - Update attributes to your role. Attributes are optional. If not set, the attributes will retain their original values.
deleteRole
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.
retrieveApiPermissionsList
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.
listObjectStorageCredentials
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.
getObjectStorageCredentials
Get S3 compatible object storage credentials. - Get S3 compatible object storage credentials for accessing it via S3 compatible tools like `aws` cli.
regenerateObjectStorageCredentials
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.
retrieveUserAuditsList
List history about your users (audit) - List and filter the history about your users.
retrieveRoleAuditsList
List history about your roles (audit) - List and filter the history about your roles.
start
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.
restart
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.
stop
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.
shutdown
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.
rescue
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.
resetPasswordAction
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.
retrieveInstancesList
List instances - List and filter all instances in your account
createInstance
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>
retrieveInstance
Get specific instance by id - Get attributes values to a specific instance on your account.
patchInstance
Update specific instance - Update specific instance by instanceId.
reinstallInstance
Reinstall specific instance - You can reinstall a specific instance with a new image and optionally add ssh keys, a root password or cloud-init.
cancelInstance
Cancel specific instance by id - Your are free to cancel a previously created instance at any time.
upgradeInstance
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.
retrieveInstancesActionsAuditsList
List history about your actions (audit) triggered via the API - List and filters the history about your actions your triggered via the API.
retrieveInstancesAuditsList
List history about your instances (audit) - List and filters the history about your instances.
retrieveImageList
List available standard and custom images - List and filter all available standard images provided by [Contabo](https://contabo.com) and your uploaded custom images.
createCustomImage
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.
retrieveImage
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
updateImage
Update custom image name by its id - Update name of the custom image
deleteImage
Delete an uploaded custom image by its id - Your are free to delete a previously uploaded custom images at any time
retrieveCustomImagesStats
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
retrieveSnapshotList
List snapshots - List and filter all your snapshots for a specific instance
createSnapshot
Create a new instance snapshot - Create a new snapshot for instance, with name and description attributes
retrieveSnapshot
Retrieve a specific snapshot by id - Get all attributes for a specific snapshot
updateSnapshot
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.
deleteSnapshot
Delete existing snapshot by id - Delete existing instance snapshot by id
rollbackSnapshot
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
retrieveImageAuditsList1
List history about your custom images (audit) - List and filters the history about your custom images.
retrieveSnapshotsAuditsList
List history about your snapshots (audit) triggered via the API - List and filters the history about your snapshots your triggered via the API.
listHandles
List all handles - List and filter all your handles
createHandle
Create specific handle - Create specific handle
retrieveHandle
Get specific handle - Get specific handle
removeHandle
Remove specific handle - Remove specific handle
updateHandle
Update specific handle - Update specific handle
setDefaultHandle
Set default handle - Set default handle
validateDomainAvailability
Check domain availablility - Check if a specific domain is available or not
listDomains
List all domains - List and filter all your domains
orderDomain
Create or transfer a domain - Create or transfer a domain
retrieveDomain
List specific domain - List specific domain
updateDomain
Update a specific domain - Update nameservers and handles for a specific domain
cancelDomain
Cancel a specific domain - Cancel a specific domain
getAuthCode
Get auth code for a domain - Get auth code for a domain by id
revokeCancelDomain
Revoke cancellation for a specific domain - Revoke cancellation for a specific domain
confirmDomainTransferOut
Confirm transfer out for a domain - Confirm transfer out for a domain
revokeDomainTransferOut
Revoke transfer out for a domain - Revoke transfer out for a domain
retrieveHandlesAuditsList
List history about your handles (audit) - List and filters the history about your handles.
retrieveDomainsAuditsList
List history about your Domains (audit) - List and filters the history about your Domains.
retrieveObjectStorageList
List all your object storages - List and filter all object storages in your account
createObjectStorage
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`
retrieveDataCenterList
List data centers - List all data centers and their corresponding regions.
retrieveObjectStorage
Get specific object storage by its id - Get data for a specific object storage on your account.
updateObjectStorage
Modifies the display name of object storage - Modifies the display name of object storage. Display name must be unique.
upgradeObjectStorage
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.
retrieveObjectStoragesStats
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.
CancelObjectStorage
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.
retrieveObjectStorageAuditsList
List history about your object storages (audit) - List and filters the history about your object storages.