List tags [GET /v1/tags] List and filter all tags in your account

Create a new tag [POST /v1/tags] Create a new tag in your account with attribute name and optional attribute color.

Get specific tag by id [GET /v1/tags/{tagId}] Get attributes values to a specific tag on your account.

Update specific tag by id [PATCH /v1/tags/{tagId}] Update attributes to your tag. Attributes are optional. If not set, the attributes will retain their original values.

Delete existing tag by id [DELETE /v1/tags/{tagId}] Your tag can be deleted if it is not assigned to any resource on your account. Check tag assigments before deleting tag.

List tag assignments [GET /v1/tags/{tagId}/assignments] List and filter all existing assignments for a tag in your account

Get specific assignment for the tag [GET /v1/tags/{tagId}/assignments/{resourceType}/{resourceId}] Get attributes for a specific tag assignment in your account. For this the resource type and resource id is required.

Create a new assignment for the tag [POST /v1/tags/{tagId}/assignments/{resourceType}/{resourceId}] Create a new tag assignment. This marks the specified resource with the specified tag for organizing purposes or to restrict access to that resource.

Delete existing tag assignment [DELETE /v1/tags/{tagId}/assignments/{resourceType}/{resourceId}] 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.

List history about your assignments (audit) [GET /v1/tags/audits] List and filters the history about your assignments.

List history about your assignments (audit) [GET /v1/tags/assignments/audits] List and filters the history about your assignments.

Retrieve a PTR Record by ip address [GET /v1/dns/ptrs/{ipAddress}] Get all attributes for a specific PTR Record

Edit a PTR Record by ip address [PUT /v1/dns/ptrs/{ipAddress}] Edit attributes for a specific PTR Record

Delete a PTR Record using ip address [DELETE /v1/dns/ptrs/{ipAddress}] Delete a PTR Record using ip address. Only IPv6 can be deleted

Create a new PTR Record using ip address [POST /v1/dns/ptrs] Create a new PTR Record using ip address. Only IPv6 can be created

List PTR records [GET /v1/dns/ptrs] Get a list of all PTR records, either customer or a list of IPs is required

List DNS zones [GET /v1/dns/zones] Get a list of all zones

Create DNS zone [POST /v1/dns/zones] Creates a new DNS zone for a customer

Retrieve a DNS Zone by zone name [GET /v1/dns/zones/{zoneName}] Get all attributes for a specific DNS Zone

Delete a DNS zone. [DELETE /v1/dns/zones/{zoneName}] Delete a DNS Zone using zone name.

List a DNS Zone's records [GET /v1/dns/zones/{zoneName}/records] Get all the records of a DNS Zone

Create DNS zone record [POST /v1/dns/zones/{zoneName}/records] Create resource record in a zone

Update DNS zone record [PATCH /v1/dns/zones/{zoneName}/records/{recordId}] Create resource record in a zone

Delete a DNS zone record [DELETE /v1/dns/zones/{zoneName}/records/{recordId}] Delete a DNZ Zone's record

Bulk delete DNS zone records [DELETE /v1/dns/zones/{zoneName}/records/bulk] Delete multiple zone records from a DNS Zone

List history about your DNS Zones (audit) [GET /v1/dns/zones/audits] List and filters the history about your DNS Zones .

List history about your DNS Records (audit) [GET /v1/dns/records/audits] List and filter the history of changes made to your DNS Records.

List VIPs [GET /v1/vips] List and filter all vips in your account

Get specific VIP by ip [GET /v1/vips/{ip}] Get attributes values to a specific VIP on your account.

Assign a VIP to an VPS/VDS/Bare Metal [POST /v1/vips/{ip}/{resourceType}/{resourceId}] Assign a VIP to a VPS/VDS/Bare Metal using the machine id.

Unassign a VIP to a VPS/VDS/Bare Metal [DELETE /v1/vips/{ip}/{resourceType}/{resourceId}] Unassign a VIP from an VPS/VDS/Bare Metal using the machine id.

List history about your VIPs (audit) [GET /v1/vips/audits] List and filters the history about your VIPs.

List secrets [GET /v1/secrets] List and filter all secrets in your account.

Create a new secret [POST /v1/secrets] Create a new secret in your account with attributes name, type and value. Attribute type can be password or ssh.

Get specific secret by id [GET /v1/secrets/{secretId}] Get attributes values for a specific secret on your account.

Update specific secret by id [PATCH /v1/secrets/{secretId}] 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.

Delete existing secret by id [DELETE /v1/secrets/{secretId}] You can remove a specific secret from your account.

List history about your secrets (audit) [GET /v1/secrets/audits] List and filters the history about your secrets.

List Private Networks [GET /v1/private-networks] List and filter all Private Networks in your account

Create a new Private Network [POST /v1/private-networks] Create a new Private Network in your account.

Update a Private Network by id [PATCH /v1/private-networks/{privateNetworkId}] Update a Private Network by id in your account.

Get specific Private Network by id [GET /v1/private-networks/{privateNetworkId}] Get attributes values to a specific Private Network on your account.

Delete existing Private Network by id [DELETE /v1/private-networks/{privateNetworkId}] Delete existing Virtual Private Cloud by id and automatically unassign all instances from it

Add instance to a Private Network [POST /v1/private-networks/{privateNetworkId}/instances/{instanceId}] Add a specific instance to a Private Network

Remove instance from a Private Network [DELETE /v1/private-networks/{privateNetworkId}/instances/{instanceId}] Remove a specific instance from a Private Network

List history about your Private Networks (audit) [GET /v1/private-networks/audits] List and filters the history about your Private Networks.

List users [GET /v1/users] List and filter all your users.

Create a new user [POST /v1/users] Create a new user with required attributes firstName, lastName, 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.

Get specific user by id [GET /v1/users/{userId}] Get attributes for a specific user.

Update specific user by id [PATCH /v1/users/{userId}] 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.

Delete existing user by id [DELETE /v1/users/{userId}] 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.

Send reset password email [POST /v1/users/{userId}/reset-password] Send reset password email for a specific user

Resend email verification [POST /v1/users/{userId}/resend-email-verification] Resend email verification for a specific user

Generate one time SSO token [POST /v1/users/sso-token] Generate an one time SSO token for the authenticated user account.

Get client [GET /v1/users/client] Get idm client.

Generate new client secret [PUT /v1/users/client/secret] Generate and get new client secret.

Get user is password set status [GET /v1/users/is-password-set] Get info about idm user if the password is set.

Request email change [POST /v1/users/{userId}/mail-change-requests] Request an email change for the specified user. Available to account owners and sub-users alike, but only for their own identity: the userId must be the subject of the access token.

Request recovery codes reset [POST /v1/users/{userId}/recovery-codes-reset-requests] Marks the user to generate new recovery codes on next login. Only for the own identity: the userId must be the subject of the access token.

Switch user account [POST /v1/me/action/switchAccount] Switch user account

Make user account default [PATCH /v1/me/account/{tenantId}/{customerId}] Make user account default

List of your accounts [GET /v1/me/accounts] List of your accounts

List roles [GET /v1/roles] List and filter all your roles. A role allows you to specify permission to api endpoints and resources like compute.

Create a new role [POST /v1/roles] 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.

Get specific role by id [GET /v1/roles/{roleId}] Get attributes of specific role.

Update specific role by id [PUT /v1/roles/{roleId}] Update attributes to your role. Attributes are optional. If not set, the attributes will retain their original values.

Delete existing role by id [DELETE /v1/roles/{roleId}] You can't delete a role if it is still assigned to a user. In such cases please remove the role from the users.

List of API permissions [GET /v1/roles/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.

Get list of S3 compatible object storage credentials for user. [GET /v1/users/{userId}/object-storages/credentials] Get list of S3 compatible object storage credentials for accessing it via S3 compatible tools like aws cli.

Get S3 compatible object storage credentials. [GET /v1/users/{userId}/object-storages/{objectStorageId}/credentials/{credentialId}] Get S3 compatible object storage credentials for accessing it via S3 compatible tools like aws cli.

Regenerates secret key of specified user for the S3 compatible object storages. [PATCH /v1/users/{userId}/object-storages/{objectStorageId}/credentials/{credentialId}] Regenerates secret key of specified user for the a specific S3 compatible object storages.

List history about your users (audit) [GET /v1/users/audits] List and filter the history about your users.

List history about your roles (audit) [GET /v1/roles/audits] List and filter the history about your roles.

Create a new firewall definition [POST /v1/firewalls] Create a new firewall definition by specifying its name and a set of rules. The status of the firewall determines whether the rules are active or not.

List all firewalls [GET /v1/firewalls] List and filter all firewalls on your account

Delete existing firewall by id [DELETE /v1/firewalls/{firewallId}] Delete existing firewall by id. A firewall cannot be deleted if there are instances attached to it.

Get specific firewall by its id [GET /v1/firewalls/{firewallId}] Get data for a specific firewall on your account.

Update a firewall by id [PATCH /v1/firewalls/{firewallId}] Update a firewall by id in your account.

Update specific firewall rules [PUT /v1/firewalls/{firewallId}] Set rules for a specific firewall. Currently only inbound rules are allowed to be configured.

Add instance to a firewall [POST /v1/firewalls/{firewallId}/instances/{instanceId}] Add a specific instance to a firewall

Remove instance from a firewall [DELETE /v1/firewalls/{firewallId}/instances/{instanceId}] Remove a specific instance from a firewall

Get all preset rules [GET /v1/firewalls/preset-rules]

List history about your Firewalls (audit) [GET /v1/firewalls/audits] List and filters the history about your Firewalls.

List check [GET /v1/troubleshooting/checks] List and filter all check

Start check [POST /v1/troubleshooting/checks] Start a new check

Get check [GET /v1/troubleshooting/checks/{checkId}] Get a single check by id

Cancel check [PATCH /v1/troubleshooting/checks/{checkId}] Cancel check

List check collections [GET /v1/troubleshooting/check-collections] List and filter all check collections

Start check collection [POST /v1/troubleshooting/check-collections] Start a new check collection

Get check collection [GET /v1/troubleshooting/check-collections/{checkCollectionId}] Get a single check collection by id

Cancel check collection [PATCH /v1/troubleshooting/check-collections/{checkCollectionId}] Cancel check collection

List check collection templates [GET /v1/troubleshooting/check-collection-templates] List and filter all check collection templates

Get check [GET /v1/troubleshooting/check-collection-templates/{checkCollectionTemplateId}] Get a single check collection template by id

List remedy [GET /v1/troubleshooting/remedies] List and filter all remedy

Start remedy [POST /v1/troubleshooting/remedies] Start a new remedy

Get remedy [GET /v1/troubleshooting/remedies/{remedyId}] Get a single remedy by id

Cancel remedy [PATCH /v1/troubleshooting/remedies/{remedyId}] Cancel remedy

Start a compute instance / resource identified by its id [POST /v1/compute/instances/{instanceId}/actions/start] 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 a compute instance / resource identified by its id. [POST /v1/compute/instances/{instanceId}/actions/restart] To restart a compute instance that has been identified by its id, you should perform a restart action on it.

Stop compute instance / resource by its id [POST /v1/compute/instances/{instanceId}/actions/stop] 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 compute instance / resource by its id [POST /v1/compute/instances/{instanceId}/actions/shutdown] 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 a compute instance / resource identified by its id [POST /v1/compute/instances/{instanceId}/actions/rescue] 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.

Reset password for a compute instance / resource referenced by an id [POST /v1/compute/instances/{instanceId}/actions/resetPassword] 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.

List instances [GET /v1/compute/instances] List and filter all instances in your account

Create a new instance [POST /v1/compute/instances] Create a new instance for your account with the provided parameters. ProductIdProductDisk Size V153Cloud VPS 4100 GB SSD V154Cloud VPS 6200 GB SSD V155Cloud VPS 8300 GB SSD V156Cloud VPS 12400 GB SSD V157Cloud VPS 16<td...

Check if the instance can be moved to another host [GET /v1/compute/instances/{instanceId}/regionChange/check] Verifies preconditions with CMS before relocating the instance from its current host. Returns no content when the check succeeds. When CMS responds with an error list, returns that payload with the same HTTP status as CMS.

Request instance region change [POST /v1/compute/instances/{instanceId}/regionChange] Starts a region change for the instance via CMS. Returns the support ticket number when the operation was accepted.

Get specific instance by id [GET /v1/compute/instances/{instanceId}] Get attributes values to a specific instance on your account.

Update specific instance [PATCH /v1/compute/instances/{instanceId}] Update specific instance by instanceId.

Reinstall specific instance [PUT /v1/compute/instances/{instanceId}] You can reinstall a specific instance with a new image and optionally add ssh keys, a root password or cloud-init.

Get the available products of a specific instance [GET /v1/compute/instances/{instanceId}/products/available] Get all products the instance can be upgraded to, excluding the currently assigned one. Use the offerId of the desired product to submit the upgrade.

Cancel specific instance by id [POST /v1/compute/instances/{instanceId}/cancel] Your are free to cancel a previously created instance at any time.

Upgrading instance capabilities [POST /v1/compute/instances/{instanceId}/upgrade] In order to enhance your instance with additional features you can purchase add-ons. Currently only firewalling and private network addon is allowed.

List history about your actions (audit) triggered via the API [GET /v1/compute/instances/actions/audits] List and filters the history about your actions your triggered via the API.

List history about your instances (audit) [GET /v1/compute/instances/audits] List and filters the history about your instances.

List available standard and custom images [GET /v1/compute/images] List and filter all available standard images provided by Contabo and your uploaded custom images.

Provide a custom image [POST /v1/compute/images] 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.

Get details about a specific image by its id [GET /v1/compute/images/{imageId}] 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

Update custom image name by its id [PATCH /v1/compute/images/{imageId}] Update name of the custom image

Delete an uploaded custom image by its id [DELETE /v1/compute/images/{imageId}] Your are free to delete a previously uploaded custom images at any time

List statistics regarding the customer's custom images [GET /v1/compute/images/stats] 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

List snapshots [GET /v1/compute/instances/{instanceId}/snapshots] List and filter all your snapshots for a specific instance

Create a new instance snapshot [POST /v1/compute/instances/{instanceId}/snapshots] Create a new snapshot for instance, with name and description attributes

Retrieve a specific snapshot by id [GET /v1/compute/instances/{instanceId}/snapshots/{snapshotId}] Get all attributes for a specific snapshot

Update specific snapshot by id [PATCH /v1/compute/instances/{instanceId}/snapshots/{snapshotId}] 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.

Delete existing snapshot by id [DELETE /v1/compute/instances/{instanceId}/snapshots/{snapshotId}] Delete existing instance snapshot by id

Revert the instance to a particular snapshot based on its identifier [POST /v1/compute/instances/{instanceId}/snapshots/{snapshotId}/rollback] 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

List history about your custom images (audit) [GET /v1/compute/images/audits] List and filters the history about your custom images.

List history about your snapshots (audit) triggered via the API [GET /v1/compute/snapshots/audits] List and filters the history about your snapshots your triggered via the API.

List all handles [GET /v1/domains/handles] List and filter all your handles

Create specific handle [POST /v1/domains/handles] Create specific handle

Get specific handle [GET /v1/domains/handles/{handleId}] Get specific handle

Remove specific handle [DELETE /v1/domains/handles/{handleId}] Remove specific handle

Update specific handle [PUT /v1/domains/handles/{handleId}] Update specific handle

Set default handle [PATCH /v1/domains/handles/{handleId}/default] Set default handle

Check domain availablility [POST /v1/registries-domains/{domain}/check-availability] Check if a specific domain is available or not

List all domains [GET /v1/domains] List and filter all your domains

Create or transfer a domain [POST /v1/domains] Create or transfer a domain

List pending domain actions [GET /v1/domains/pending-actions] List the calling customer's domains with an unacknowledged outbound transfer (ACK/NACK) pending. Live OpusDNS read for OpusDNS-routed customers; empty payload (no upstream call) for everyone else.

Suggest domains [GET /v1/domains/suggestions] Return available domain-name suggestions for a query across a TLD set.

List specific domain [GET /v1/domains/{domain}] List specific domain

Update a specific domain [PATCH /v1/domains/{domain}] Update nameservers and handles for a specific domain

Cancel a specific domain [POST /v1/domains/{domain}/cancel] Cancel a specific domain

Get auth code for a domain [POST /v1/domains/{domain}/generate-auth-code] Get auth code for a domain by id

Revoke cancellation for a specific domain [POST /v1/domains/{domain}/revoke-cancellation] Revoke cancellation for a specific domain

Confirm transfer out for a domain [POST /v1/domains/{domain}/transfer-out] Confirm transfer out for a domain

Revoke transfer out for a domain [DELETE /v1/domains/{domain}/transfer-out] Revoke transfer out for a domain

List history about your handles (audit) [GET /v1/domains/handles/audits] List and filters the history about your handles.

List history about your Domains (audit) [GET /v1/domains/audits] List and filters the history about your Domains.

List all your object storages [GET /v1/object-storages] List and filter all object storages in your account

Create a new object storage [POST /v1/object-storages] 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

List data centers [GET /v1/data-centers] List all data centers and their corresponding regions.

Get specific object storage by its id [GET /v1/object-storages/{objectStorageId}] Get data for a specific object storage on your account.

Modifies the display name of object storage [PATCH /v1/object-storages/{objectStorageId}] Modifies the display name of object storage. Display name must be unique.

Upgrade object storage size resp. update autoscaling settings. [POST /v1/object-storages/{objectStorageId}/resize] 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.

List usage statistics about the specified object storage [GET /v1/object-storages/{objectStorageId}/stats] 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.

Cancels the specified object storage at the next possible date [PATCH /v1/object-storages/{objectStorageId}/cancel] Cancels the specified object storage at the next possible date. Please be aware of your contract periods.

List history about your object storages (audit) [GET /v1/object-storages/audits] List and filters the history about your object storages.