Contabo API (v1.0.0) as MCP tools for cloud provisioning, and management. Powered by HAPI MCP server
Manage Contabo cloud infrastructure provisioning and resources via API.
Captured live from the server via tools/list.
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.
Parameters (2)
querystringrequired
A regex pattern or natural-language query to search tool names, descriptions, and argument names. Maximum 200 characters.
modestring
Search mode: "regex" for pattern matching, "bm25" for natural language. Defaults to "bm25".
retrieveTagList
List tags - List and filter all tags in your account
Parameters (6)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
namestring
createTag
Create a new tag - Create a new tag in your account with attribute name and optional attribute color.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
createTagBodyobjectrequired
retrieveTag
Get specific tag by id - Get attributes values to a specific tag on your account.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
tagIdintegerrequired
updateTag
Update specific tag by id - Update attributes to your tag. Attributes are optional. If not set, the attributes will retain their original values.
Parameters (4)
x-request-idstringrequired
x-trace-idstring
tagIdintegerrequired
updateTagBodyobjectrequired
deleteTag
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.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
tagIdintegerrequired
retrieveAssignmentList
List tag assignments - List and filter all existing assignments for a tag in your account
Parameters (7)
x-request-idstringrequired
x-trace-idstring
tagIdintegerrequired
pageinteger
sizeinteger
orderByarray
resourceTypestring
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.
Parameters (5)
x-request-idstringrequired
x-trace-idstring
tagIdintegerrequired
resourceTypestringrequired
resourceIdstringrequired
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.
Parameters (5)
x-request-idstringrequired
x-trace-idstring
tagIdintegerrequired
resourceTypestringrequired
resourceIdstringrequired
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.
Parameters (5)
x-request-idstringrequired
x-trace-idstring
tagIdintegerrequired
resourceTypestringrequired
resourceIdstringrequired
retrieveTagAuditsList
List history about your assignments (audit) - List and filters the history about your assignments.
Parameters (10)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
tagIdinteger
requestIdstring
changedBystring
startDatestring
endDatestring
retrieveAssignmentsAuditsList
List history about your assignments (audit) - List and filters the history about your assignments.
Parameters (11)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
tagIdinteger
resourceIdstring
requestIdstring
changedBystring
startDatestring
endDatestring
retrievePtrRecord
Retrieve a PTR Record by ip address - Get all attributes for a specific PTR Record
Parameters (3)
x-request-idstringrequired
x-trace-idstring
ipAddressstringrequired
updatePtrRecord
Edit a PTR Record by ip address - Edit attributes for a specific PTR Record
Parameters (4)
x-request-idstringrequired
x-trace-idstring
ipAddressstringrequired
updatePtrRecordBodyobjectrequired
deletePtrRecord
Delete a PTR Record using ip address - Delete a PTR Record using ip address. Only IPv6 can be deleted
Parameters (3)
x-request-idstringrequired
x-trace-idstring
ipAddressstringrequired
createPtrRecord
Create a new PTR Record using ip address - Create a new PTR Record using ip address. Only IPv6 can be created
Parameters (3)
x-request-idstringrequired
x-trace-idstring
createPtrRecordBodyobjectrequired
retrievePtrRecordsList
List PTR records - Get a list of all PTR records, either customer or a list of IPs is required
Parameters (9)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
customerIdstring
tenantIdstring
ipsarray
searchstring
retrieveDnsZonesList
List DNS zones - Get a list of all zones
Parameters (8)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
customerIdstring
tenantIdstring
zoneNamestring
createDnsZone
Create DNS zone - Creates a new DNS zone for a customer
Parameters (3)
x-request-idstringrequired
x-trace-idstring
createDnsZoneBodyobjectrequired
retrieveDnsZone
Retrieve a DNS Zone by zone name - Get all attributes for a specific DNS Zone
Parameters (3)
x-request-idstringrequired
x-trace-idstring
zoneNamestringrequired
deleteDnsZone
Delete a DNS zone. - Delete a DNS Zone using zone name.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
zoneNamestringrequired
retrieveDnsZoneRecordsList
List a DNS Zone's records - Get all the records of a DNS Zone
Parameters (7)
x-request-idstringrequired
x-trace-idstring
zoneNamestringrequired
pageinteger
sizeinteger
orderByarray
searchstring
createDnsZoneRecord
Create DNS zone record - Create resource record in a zone
Parameters (4)
x-request-idstringrequired
x-trace-idstring
zoneNamestringrequired
createDnsZoneRecordBodyobjectrequired
updateDnsZoneRecord
Update DNS zone record - Create resource record in a zone
Parameters (5)
x-request-idstringrequired
x-trace-idstring
recordIdintegerrequired
zoneNamestringrequired
updateDnsZoneRecordBodyobjectrequired
deleteDnsZoneRecord
Delete a DNS zone record - Delete a DNZ Zone's record
Parameters (4)
x-request-idstringrequired
x-trace-idstring
recordIdintegerrequired
zoneNamestringrequired
bulkDeleteDnsZoneRecords
Bulk delete DNS zone records - Delete multiple zone records from a DNS Zone
Parameters (4)
x-request-idstringrequired
x-trace-idstring
zoneNamestringrequired
bulkDeleteDnsZoneRecordsBodyobjectrequired
retrieveImageAuditsList
List history about your DNS Zones (audit) - List and filters the history about your DNS Zones .
Parameters (10)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
namestring
requestIdstring
changedBystring
startDatestring
endDatestring
retrieveRecordAuditsList
List history about your DNS Records (audit) - List and filter the history of changes made to your DNS Records.
Parameters (10)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
recordIdinteger
requestIdstring
changedBystring
startDatestring
endDatestring
retrieveVipList
List VIPs - List and filter all vips in your account
Parameters (15)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
resourceIdstring
resourceTypestring
resourceNamestring
resourceDisplayNamestring
ipVersionstring
ipsstring
ipstring
typestring
dataCenterstring
regionstring
retrieveVip
Get specific VIP by ip - Get attributes values to a specific VIP on your account.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
ipstringrequired
assignIp
Assign a VIP to an VPS/VDS/Bare Metal - Assign a VIP to a VPS/VDS/Bare Metal using the machine id.
Parameters (5)
x-request-idstringrequired
x-trace-idstring
resourceIdintegerrequired
ipstringrequired
resourceTypestringrequired
unassignIp
Unassign a VIP to a VPS/VDS/Bare Metal - Unassign a VIP from an VPS/VDS/Bare Metal using the machine id.
Parameters (5)
x-request-idstringrequired
x-trace-idstring
resourceIdintegerrequired
ipstringrequired
resourceTypestringrequired
retrieveVipAuditsList
List history about your VIPs (audit) - List and filters the history about your VIPs.
Parameters (10)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
vipIdstring
requestIdstring
changedBystring
startDatestring
endDatestring
retrieveSecretList
List secrets - List and filter all secrets in your account.
Parameters (7)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
namestring
typestring
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.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
createSecretBodyobjectrequired
retrieveSecret
Get specific secret by id - Get attributes values for a specific secret on your account.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
secretIdintegerrequired
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.
Parameters (4)
x-request-idstringrequired
x-trace-idstring
secretIdintegerrequired
updateSecretBodyobjectrequired
deleteSecret
Delete existing secret by id - You can remove a specific secret from your account.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
secretIdintegerrequired
retrieveSecretAuditsList
List history about your secrets (audit) - List and filters the history about your secrets.
Parameters (10)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
secretIdinteger
requestIdstring
changedBystring
startDatestring
endDatestring
retrievePrivateNetworkList
List Private Networks - List and filter all Private Networks in your account
Parameters (9)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
namestring
instanceIdsstring
regionstring
dataCenterstring
createPrivateNetwork
Create a new Private Network - Create a new Private Network in your account.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
createPrivateNetworkBodyobjectrequired
patchPrivateNetwork
Update a Private Network by id - Update a Private Network by id in your account.
Parameters (4)
x-request-idstringrequired
x-trace-idstring
privateNetworkIdintegerrequired
patchPrivateNetworkBodyobjectrequired
retrievePrivateNetwork
Get specific Private Network by id - Get attributes values to a specific Private Network on your account.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
privateNetworkIdintegerrequired
deletePrivateNetwork
Delete existing Private Network by id - Delete existing Virtual Private Cloud by id and automatically unassign all instances from it
Parameters (3)
x-request-idstringrequired
x-trace-idstring
privateNetworkIdintegerrequired
assignInstancePrivateNetwork
Add instance to a Private Network - Add a specific instance to a Private Network
Parameters (4)
x-request-idstringrequired
x-trace-idstring
privateNetworkIdintegerrequired
instanceIdintegerrequired
unassignInstancePrivateNetwork
Remove instance from a Private Network - Remove a specific instance from a Private Network
Parameters (4)
x-request-idstringrequired
x-trace-idstring
privateNetworkIdintegerrequired
instanceIdintegerrequired
retrievePrivateNetworkAuditsList
List history about your Private Networks (audit) - List and filters the history about your Private Networks.
Parameters (10)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
privateNetworkIdinteger
requestIdstring
changedBystring
startDatestring
endDatestring
retrieveUserList
List users - List and filter all your users.
Parameters (8)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
emailstring
enabledboolean
ownerboolean
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.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
createUserBodyobjectrequired
retrieveUser
Get specific user by id - Get attributes for a specific user.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
userIdstringrequired
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.
Parameters (4)
x-request-idstringrequired
x-trace-idstring
userIdstringrequired
updateUserBodyobjectrequired
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.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
userIdstringrequired
resetPassword
Send reset password email - Send reset password email for a specific user
Parameters (4)
x-request-idstringrequired
x-trace-idstring
userIdstringrequired
redirectUrlstring
resendEmailVerification
Resend email verification - Resend email verification for a specific user
Parameters (4)
x-request-idstringrequired
x-trace-idstring
userIdstringrequired
redirectUrlstring
retrieveUserClient
Get client - Get idm client.
Parameters (2)
x-request-idstringrequired
x-trace-idstring
generateClientSecret
Generate new client secret - Generate and get new client secret.
Parameters (2)
x-request-idstringrequired
x-trace-idstring
retrieveUserIsPasswordSet
Get user is password set status - Get info about idm user if the password is set.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
userIdstring
retrieveRoleList
List roles - List and filter all your roles. A role allows you to specify permission to api endpoints and resources like compute.
Parameters (9)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
namestring
apiNamestring
tagNamestring
typestring
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.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
createRoleBodyobjectrequired
retrieveRole
Get specific role by id - Get attributes of specific role.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
roleIdintegerrequired
updateRole
Update specific role by id - Update attributes to your role. Attributes are optional. If not set, the attributes will retain their original values.
Parameters (4)
x-request-idstringrequired
x-trace-idstring
roleIdintegerrequired
updateRoleBodyobjectrequired
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.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
roleIdintegerrequired
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.
Parameters (6)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
apiNamestring
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.
Parameters (9)
x-request-idstringrequired
x-trace-idstring
userIdstringrequired
pageinteger
sizeinteger
orderByarray
objectStorageIdstring
regionNamestring
displayNamestring
getObjectStorageCredentials
Get S3 compatible object storage credentials. - Get S3 compatible object storage credentials for accessing it via S3 compatible tools like `aws` cli.
Parameters (5)
x-request-idstringrequired
x-trace-idstring
userIdstringrequired
objectStorageIdstringrequired
credentialIdintegerrequired
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.
Parameters (5)
x-request-idstringrequired
x-trace-idstring
userIdstringrequired
objectStorageIdstringrequired
credentialIdintegerrequired
retrieveUserAuditsList
List history about your users (audit) - List and filter the history about your users.
Parameters (10)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
userIdstring
requestIdstring
changedBystring
startDatestring
endDatestring
retrieveRoleAuditsList
List history about your roles (audit) - List and filter the history about your roles.
Parameters (10)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
roleIdinteger
requestIdstring
changedBystring
startDatestring
endDatestring
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.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
instanceIdintegerrequired
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.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
instanceIdintegerrequired
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.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
instanceIdintegerrequired
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.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
instanceIdintegerrequired
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.
Parameters (4)
x-request-idstringrequired
x-trace-idstring
instanceIdintegerrequired
rescueBodyobjectrequired
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.
Parameters (4)
x-request-idstringrequired
x-trace-idstring
instanceIdintegerrequired
resetPasswordActionBodyobjectrequired
retrieveInstancesList
List instances - List and filter all instances in your account
Get specific instance by id - Get attributes values to a specific instance on your account.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
instanceIdintegerrequired
patchInstance
Update specific instance - Update specific instance by instanceId.
Parameters (4)
x-request-idstringrequired
x-trace-idstring
instanceIdintegerrequired
patchInstanceBodyobjectrequired
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.
Parameters (4)
x-request-idstringrequired
x-trace-idstring
instanceIdintegerrequired
reinstallInstanceBodyobjectrequired
cancelInstance
Cancel specific instance by id - Your are free to cancel a previously created instance at any time.
Parameters (4)
x-request-idstringrequired
x-trace-idstring
instanceIdintegerrequired
cancelInstanceBodyobjectrequired
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.
Parameters (4)
x-request-idstringrequired
x-trace-idstring
instanceIdintegerrequired
upgradeInstanceBodyobjectrequired
retrieveInstancesActionsAuditsList
List history about your actions (audit) triggered via the API - List and filters the history about your actions your triggered via the API.
Parameters (10)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
instanceIdinteger
requestIdstring
changedBystring
startDatestring
endDatestring
retrieveInstancesAuditsList
List history about your instances (audit) - List and filters the history about your instances.
Parameters (10)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
instanceIdinteger
requestIdstring
changedBystring
startDatestring
endDatestring
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.
Parameters (8)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
namestring
standardImageboolean
searchstring
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.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
createCustomImageBodyobjectrequired
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
Parameters (3)
x-request-idstringrequired
x-trace-idstring
imageIdstringrequired
updateImage
Update custom image name by its id - Update name of the custom image
Parameters (4)
x-request-idstringrequired
x-trace-idstring
imageIdstringrequired
updateImageBodyobjectrequired
deleteImage
Delete an uploaded custom image by its id - Your are free to delete a previously uploaded custom images at any time
Parameters (3)
x-request-idstringrequired
x-trace-idstring
imageIdstringrequired
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
Parameters (2)
x-request-idstringrequired
x-trace-idstring
retrieveSnapshotList
List snapshots - List and filter all your snapshots for a specific instance
Parameters (7)
x-request-idstringrequired
x-trace-idstring
instanceIdintegerrequired
pageinteger
sizeinteger
orderByarray
namestring
createSnapshot
Create a new instance snapshot - Create a new snapshot for instance, with name and description attributes
Parameters (4)
x-request-idstringrequired
x-trace-idstring
instanceIdintegerrequired
createSnapshotBodyobjectrequired
retrieveSnapshot
Retrieve a specific snapshot by id - Get all attributes for a specific snapshot
Parameters (4)
x-request-idstringrequired
x-trace-idstring
instanceIdintegerrequired
snapshotIdstringrequired
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.
Parameters (5)
x-request-idstringrequired
x-trace-idstring
instanceIdintegerrequired
snapshotIdstringrequired
updateSnapshotBodyobjectrequired
deleteSnapshot
Delete existing snapshot by id - Delete existing instance snapshot by id
Parameters (4)
x-request-idstringrequired
x-trace-idstring
instanceIdintegerrequired
snapshotIdstringrequired
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
Parameters (5)
x-request-idstringrequired
x-trace-idstring
instanceIdintegerrequired
snapshotIdstringrequired
rollbackSnapshotBodyobjectrequired
retrieveImageAuditsList1
List history about your custom images (audit) - List and filters the history about your custom images.
Parameters (10)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
imageIdstring
requestIdstring
changedBystring
startDatestring
endDatestring
retrieveSnapshotsAuditsList
List history about your snapshots (audit) triggered via the API - List and filters the history about your snapshots your triggered via the API.
Parameters (11)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
instanceIdinteger
snapshotIdstring
requestIdstring
changedBystring
startDatestring
endDatestring
listHandles
List all handles - List and filter all your handles
Parameters (12)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
namestring
showDefaultsboolean
searchstring
countriesstring
handleTypestring
firstNamestring
lastNamestring
createHandle
Create specific handle - Create specific handle
Parameters (3)
x-request-idstringrequired
x-trace-idstring
createHandleBodyobjectrequired
retrieveHandle
Get specific handle - Get specific handle
Parameters (3)
x-request-idstringrequired
x-trace-idstring
handleIdstringrequired
removeHandle
Remove specific handle - Remove specific handle
Parameters (3)
x-request-idstringrequired
x-trace-idstring
handleIdstringrequired
updateHandle
Update specific handle - Update specific handle
Parameters (4)
x-request-idstringrequired
x-trace-idstring
handleIdstringrequired
updateHandleBodyobjectrequired
setDefaultHandle
Set default handle - Set default handle
Parameters (3)
x-request-idstringrequired
x-trace-idstring
handleIdstringrequired
validateDomainAvailability
Check domain availablility - Check if a specific domain is available or not
Parameters (3)
x-request-idstringrequired
x-trace-idstring
domainstringrequired
listDomains
List all domains - List and filter all your domains
Parameters (8)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
sldstring
tldstring
statusstring
orderDomain
Create or transfer a domain - Create or transfer a domain
Parameters (3)
x-request-idstringrequired
x-trace-idstring
orderDomainBodyobjectrequired
retrieveDomain
List specific domain - List specific domain
Parameters (3)
x-request-idstringrequired
x-trace-idstring
domainstringrequired
updateDomain
Update a specific domain - Update nameservers and handles for a specific domain
Parameters (4)
x-request-idstringrequired
x-trace-idstring
domainstringrequired
updateDomainBodyobjectrequired
cancelDomain
Cancel a specific domain - Cancel a specific domain
Parameters (4)
x-request-idstringrequired
x-trace-idstring
domainstringrequired
cancelDomainBodyobjectrequired
getAuthCode
Get auth code for a domain - Get auth code for a domain by id
Parameters (3)
x-request-idstringrequired
x-trace-idstring
domainstringrequired
revokeCancelDomain
Revoke cancellation for a specific domain - Revoke cancellation for a specific domain
Parameters (3)
x-request-idstringrequired
x-trace-idstring
domainstringrequired
confirmDomainTransferOut
Confirm transfer out for a domain - Confirm transfer out for a domain
Parameters (3)
x-request-idstringrequired
x-trace-idstring
domainstringrequired
revokeDomainTransferOut
Revoke transfer out for a domain - Revoke transfer out for a domain
Parameters (3)
x-request-idstringrequired
x-trace-idstring
domainstringrequired
retrieveHandlesAuditsList
List history about your handles (audit) - List and filters the history about your handles.
Parameters (10)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
handleIdstring
requestIdstring
changedBystring
startDatestring
endDatestring
retrieveDomainsAuditsList
List history about your Domains (audit) - List and filters the history about your Domains.
Parameters (10)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
domainstring
requestIdstring
changedBystring
startDatestring
endDatestring
retrieveObjectStorageList
List all your object storages - List and filter all object storages in your account
Parameters (9)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
dataCenterNamestring
s3TenantIdstring
regionstring
displayNamestring
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`
Parameters (3)
x-request-idstringrequired
x-trace-idstring
createObjectStorageBodyobjectrequired
retrieveDataCenterList
List data centers - List all data centers and their corresponding regions.
Parameters (9)
x-request-idstringrequired
x-trace-idstring
pageinteger
sizeinteger
orderByarray
slugstring
namestring
regionNamestring
regionSlugstring
retrieveObjectStorage
Get specific object storage by its id - Get data for a specific object storage on your account.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
objectStorageIdstringrequired
updateObjectStorage
Modifies the display name of object storage - Modifies the display name of object storage. Display name must be unique.
Parameters (4)
x-request-idstringrequired
x-trace-idstring
objectStorageIdstringrequired
updateObjectStorageBodyobjectrequired
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.
Parameters (4)
x-request-idstringrequired
x-trace-idstring
objectStorageIdstringrequired
upgradeObjectStorageBodyobjectrequired
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.
Parameters (3)
x-request-idstringrequired
x-trace-idstring
objectStorageIdstringrequired
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.
Parameters (4)
x-request-idstringrequired
x-trace-idstring
objectStorageIdstringrequired
CancelObjectStorageBodyobjectrequired
retrieveObjectStorageAuditsList
List history about your object storages (audit) - List and filters the history about your object storages.
HAPI MCP – Headless API for Model Context Protocol
Stop rewriting systems for AI. Instantly turn your APIs into MCP servers.
HAPI MCP lifts your OpenAPI catalog into MCP tools automatically, keeping design (OAS/Arazzo) and runtime (agents/LLMs) cleanly separated. Your existing APIs become AI-ready tools—no new business logic, no sidecar servers, no rework.
Key Features
No rewrites: Reuse 100% of your API logic. OpenAPI in, MCP tools out. No parallel codebase or shadow services.
Faster time-to-value: Turn specs into agent-ready tools in minutes. Update the spec, ship new tools instantly.
Reduced risk: Permissions, auth, rate limits, auditability are inherited from your APIs—governance without bolt-ons.
Scales with you:runMCP delivers serverless-like elasticity with long-running when needed. Cold-start fast, stay warm for throughput.
Do we need to rewrite our services?
No. HAPI MCP lifts your existing OpenAPI specs directly into MCP tools. Your auth, validation, and business rules remain unchanged.
Is this just another MCP server?
It’s the Headless API model: your API becomes the runtime. HAPI Server reflects it as MCP; runMCP scales it; OrcA orchestrates it. No duplicate logic.
Which clients can consume the tools?
Any MCP client: ChatGPT, Claude, QBot, chatMCP, bespoke orchestrators—vendor-neutral by design.
How do we keep control and compliance?
Your API remains the single source of truth. Policies, RBAC, rate limits, and audit logs flow through automatically; no shadow logic.
What about security and privacy?
Scoped credentials, per-tool permissions, and auditable calls are inherited from your API layer. HAPI adds guardrails and observability for regulated environments.
How fast can we get started?
You can transform your first API into an MCP tool in less than five minutes. The HAPI CLI makes it quick and painless.