Server Details
Contabo API (v1.0.0) as MCP tools for cloud provisioning, and management. Powered by HAPI MCP server
- Status
- Healthy
- Last Tested
- Transport
- Streamable HTTP
- URL
- Repository
- la-rebelion/hapimcp
- GitHub Stars
- 7
Available Tools
123 toolsassignInstancePrivateNetworkTry in Inspector
Add instance to a Private Network - Add a specific instance to a Private Network
| Name | Required | Description | Default |
|---|---|---|---|
| instanceId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| privateNetworkId | Yes | ||
| x-hapi-auth-state | No |
assignIpTry in Inspector
Assign a VIP to an VPS/VDS/Bare Metal - Assign a VIP to a VPS/VDS/Bare Metal using the machine id.
| Name | Required | Description | Default |
|---|---|---|---|
| ip | Yes | ||
| resourceId | Yes | ||
| x-trace-id | No | ||
| resourceType | Yes | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
bulkDeleteDnsZoneRecordsTry in Inspector
Bulk delete DNS zone records - Delete multiple zone records from a DNS Zone
| Name | Required | Description | Default |
|---|---|---|---|
| zoneName | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No | ||
| bulkDeleteDnsZoneRecordsBody | Yes |
cancelDomainTry in Inspector
Cancel a specific domain - Cancel a specific domain
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| cancelDomainBody | Yes | ||
| x-hapi-auth-state | No |
cancelInstanceTry in Inspector
Cancel specific instance by id - Your are free to cancel a previously created instance at any time.
| Name | Required | Description | Default |
|---|---|---|---|
| instanceId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No | ||
| cancelInstanceBody | Yes |
CancelObjectStorageTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| objectStorageId | Yes | ||
| x-hapi-auth-state | No | ||
| CancelObjectStorageBody | Yes |
confirmDomainTransferOutTry in Inspector
Confirm transfer out for a domain - Confirm transfer out for a domain
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
createAssignmentTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| tagId | Yes | ||
| resourceId | Yes | ||
| x-trace-id | No | ||
| resourceType | Yes | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
createCustomImageTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No | ||
| createCustomImageBody | Yes |
createDnsZoneTry in Inspector
Create DNS zone - Creates a new DNS zone for a customer
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| createDnsZoneBody | Yes | ||
| x-hapi-auth-state | No |
createDnsZoneRecordTry in Inspector
Create DNS zone record - Create resource record in a zone
| Name | Required | Description | Default |
|---|---|---|---|
| zoneName | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No | ||
| createDnsZoneRecordBody | Yes |
createHandleTry in Inspector
Create specific handle - Create specific handle
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| createHandleBody | Yes | ||
| x-hapi-auth-state | No |
createInstanceTry in Inspector
Create a new instance - Create a new instance for your account with the provided parameters. ProductIdProductDisk Size V91VPS 10 NVMe75 GB NVMe V92VPS 10 SSD150 GB SSD V93VPS 10 Storage300 GB SSD V94VPS 20 NVMe100 GB NVMe V95VPS 20 SSD200 GB SSD V96VPS 20 Storage400 GB SSD V97VPS 30 NVMe200 GB NVMe V98VPS 30 SSD400 GB SSD V99VPS 30 Storage1000 GB NVMe V100VPS 40 NVMe250 GB NVMe V101VPS 40 SSD500 GB SSD V102VPS 40 Storage1200 GB NVMe V103VPS 50 NVMe300 GB NVMe V104VPS 50 SSD600 GB SSD V105VPS 50 Storage1400 GB SSD V106VPS 60 NVMe350 GB NVMe V107VPS 60 SSD700 GB SSD V8VDS S180 GB NVMe V9VDS M240 GB NVMe V10VDS L360 GB NVMe V11VDS XL480 GB NVMe V16VDS XXL720 GB NVMe
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No | ||
| createInstanceBody | Yes |
createObjectStorageTry in Inspector
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
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No | ||
| createObjectStorageBody | Yes |
createPrivateNetworkTry in Inspector
Create a new Private Network - Create a new Private Network in your account.
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No | ||
| createPrivateNetworkBody | Yes |
createPtrRecordTry in Inspector
Create a new PTR Record using ip address - Create a new PTR Record using ip address. Only IPv6 can be created
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No | ||
| createPtrRecordBody | Yes |
createRoleTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| createRoleBody | Yes | ||
| x-hapi-auth-state | No |
createSecretTry in Inspector
Create a new secret - Create a new secret in your account with attributes name, type and value. Attribute type can be password or ssh.
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| createSecretBody | Yes | ||
| x-hapi-auth-state | No |
createSnapshotTry in Inspector
Create a new instance snapshot - Create a new snapshot for instance, with name and description attributes
| Name | Required | Description | Default |
|---|---|---|---|
| instanceId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No | ||
| createSnapshotBody | Yes |
createTagTry in Inspector
Create a new tag - Create a new tag in your account with attribute name and optional attribute color.
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| createTagBody | Yes | ||
| x-hapi-auth-state | No |
createUserTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| createUserBody | Yes | ||
| x-hapi-auth-state | No |
deleteAssignmentTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| tagId | Yes | ||
| resourceId | Yes | ||
| x-trace-id | No | ||
| resourceType | Yes | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
deleteDnsZoneTry in Inspector
Delete a DNS zone. - Delete a DNS Zone using zone name.
| Name | Required | Description | Default |
|---|---|---|---|
| zoneName | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
deleteDnsZoneRecordTry in Inspector
Delete a DNS zone record - Delete a DNZ Zone's record
| Name | Required | Description | Default |
|---|---|---|---|
| recordId | Yes | ||
| zoneName | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
deleteImageTry in Inspector
Delete an uploaded custom image by its id - Your are free to delete a previously uploaded custom images at any time
| Name | Required | Description | Default |
|---|---|---|---|
| imageId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
deletePrivateNetworkTry in Inspector
Delete existing Private Network by id - Delete existing Virtual Private Cloud by id and automatically unassign all instances from it
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| privateNetworkId | Yes | ||
| x-hapi-auth-state | No |
deletePtrRecordTry in Inspector
Delete a PTR Record using ip address - Delete a PTR Record using ip address. Only IPv6 can be deleted
| Name | Required | Description | Default |
|---|---|---|---|
| ipAddress | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
deleteRoleTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| roleId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
deleteSecretTry in Inspector
Delete existing secret by id - You can remove a specific secret from your account.
| Name | Required | Description | Default |
|---|---|---|---|
| secretId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
deleteSnapshotTry in Inspector
Delete existing snapshot by id - Delete existing instance snapshot by id
| Name | Required | Description | Default |
|---|---|---|---|
| instanceId | Yes | ||
| snapshotId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
deleteTagTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| tagId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
deleteUserTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
generateClientSecretTry in Inspector
Generate new client secret - Generate and get new client secret.
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
getAuthCodeTry in Inspector
Get auth code for a domain - Get auth code for a domain by id
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
getObjectStorageCredentialsTry in Inspector
Get S3 compatible object storage credentials. - Get S3 compatible object storage credentials for accessing it via S3 compatible tools like aws cli.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | ||
| x-trace-id | No | ||
| credentialId | Yes | ||
| x-request-id | Yes | ||
| objectStorageId | Yes | ||
| x-hapi-auth-state | No |
listDomainsTry in Inspector
List all domains - List and filter all your domains
| Name | Required | Description | Default |
|---|---|---|---|
| sld | No | ||
| tld | No | ||
| page | No | ||
| size | No | ||
| status | No | ||
| orderBy | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
listHandlesTry in Inspector
List all handles - List and filter all your handles
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| page | No | ||
| size | No | ||
| search | No | ||
| orderBy | No | ||
| lastName | No | ||
| countries | No | ||
| firstName | No | ||
| handleType | No | ||
| x-trace-id | No | ||
| showDefaults | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
listObjectStorageCredentialsTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| userId | Yes | ||
| orderBy | No | ||
| regionName | No | ||
| x-trace-id | No | ||
| displayName | No | ||
| x-request-id | Yes | ||
| objectStorageId | No | ||
| x-hapi-auth-state | No |
orderDomainTry in Inspector
Create or transfer a domain - Create or transfer a domain
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| orderDomainBody | Yes | ||
| x-hapi-auth-state | No |
patchInstanceTry in Inspector
Update specific instance - Update specific instance by instanceId.
| Name | Required | Description | Default |
|---|---|---|---|
| instanceId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| patchInstanceBody | Yes | ||
| x-hapi-auth-state | No |
patchPrivateNetworkTry in Inspector
Update a Private Network by id - Update a Private Network by id in your account.
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| privateNetworkId | Yes | ||
| x-hapi-auth-state | No | ||
| patchPrivateNetworkBody | Yes |
regenerateObjectStorageCredentialsTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | ||
| x-trace-id | No | ||
| credentialId | Yes | ||
| x-request-id | Yes | ||
| objectStorageId | Yes | ||
| x-hapi-auth-state | No |
reinstallInstanceTry in Inspector
Reinstall specific instance - You can reinstall a specific instance with a new image and optionally add ssh keys, a root password or cloud-init.
| Name | Required | Description | Default |
|---|---|---|---|
| instanceId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No | ||
| reinstallInstanceBody | Yes |
removeHandleTry in Inspector
Remove specific handle - Remove specific handle
| Name | Required | Description | Default |
|---|---|---|---|
| handleId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
rescueTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| instanceId | Yes | ||
| rescueBody | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
resendEmailVerificationTry in Inspector
Resend email verification - Resend email verification for a specific user
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | ||
| x-trace-id | No | ||
| redirectUrl | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
resetPasswordTry in Inspector
Send reset password email - Send reset password email for a specific user
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | ||
| x-trace-id | No | ||
| redirectUrl | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
resetPasswordActionTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| instanceId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No | ||
| resetPasswordActionBody | Yes |
restartTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| instanceId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveApiPermissionsListTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| apiName | No | ||
| orderBy | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveAssignmentTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| tagId | Yes | ||
| resourceId | Yes | ||
| x-trace-id | No | ||
| resourceType | Yes | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveAssignmentListTry in Inspector
List tag assignments - List and filter all existing assignments for a tag in your account
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| tagId | Yes | ||
| orderBy | No | ||
| x-trace-id | No | ||
| resourceType | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveAssignmentsAuditsListTry in Inspector
List history about your assignments (audit) - List and filters the history about your assignments.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| tagId | No | ||
| endDate | No | ||
| orderBy | No | ||
| changedBy | No | ||
| requestId | No | ||
| startDate | No | ||
| resourceId | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveCustomImagesStatsTry in Inspector
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
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveDataCenterListTry in Inspector
List data centers - List all data centers and their corresponding regions.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| page | No | ||
| size | No | ||
| slug | No | ||
| orderBy | No | ||
| regionName | No | ||
| regionSlug | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveDnsZoneTry in Inspector
Retrieve a DNS Zone by zone name - Get all attributes for a specific DNS Zone
| Name | Required | Description | Default |
|---|---|---|---|
| zoneName | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveDnsZoneRecordsListTry in Inspector
List a DNS Zone's records - Get all the records of a DNS Zone
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| search | No | ||
| orderBy | No | ||
| zoneName | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveDnsZonesListTry in Inspector
List DNS zones - Get a list of all zones
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| orderBy | No | ||
| tenantId | No | ||
| zoneName | No | ||
| customerId | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveDomainTry in Inspector
List specific domain - List specific domain
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveDomainsAuditsListTry in Inspector
List history about your Domains (audit) - List and filters the history about your Domains.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| domain | No | ||
| endDate | No | ||
| orderBy | No | ||
| changedBy | No | ||
| requestId | No | ||
| startDate | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveHandleTry in Inspector
Get specific handle - Get specific handle
| Name | Required | Description | Default |
|---|---|---|---|
| handleId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveHandlesAuditsListTry in Inspector
List history about your handles (audit) - List and filters the history about your handles.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| endDate | No | ||
| orderBy | No | ||
| handleId | No | ||
| changedBy | No | ||
| requestId | No | ||
| startDate | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveImageTry in Inspector
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
| Name | Required | Description | Default |
|---|---|---|---|
| imageId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveImageAuditsListTry in Inspector
List history about your DNS Zones (audit) - List and filters the history about your DNS Zones .
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| page | No | ||
| size | No | ||
| endDate | No | ||
| orderBy | No | ||
| changedBy | No | ||
| requestId | No | ||
| startDate | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveImageAuditsList1Try in Inspector
List history about your custom images (audit) - List and filters the history about your custom images.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| endDate | No | ||
| imageId | No | ||
| orderBy | No | ||
| changedBy | No | ||
| requestId | No | ||
| startDate | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveImageListTry in Inspector
List available standard and custom images - List and filter all available standard images provided by Contabo and your uploaded custom images.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| page | No | ||
| size | No | ||
| search | No | ||
| orderBy | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| standardImage | No | ||
| x-hapi-auth-state | No |
retrieveInstanceTry in Inspector
Get specific instance by id - Get attributes values to a specific instance on your account.
| Name | Required | Description | Default |
|---|---|---|---|
| instanceId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveInstancesActionsAuditsListTry in Inspector
List history about your actions (audit) triggered via the API - List and filters the history about your actions your triggered via the API.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| endDate | No | ||
| orderBy | No | ||
| changedBy | No | ||
| requestId | No | ||
| startDate | No | ||
| instanceId | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveInstancesAuditsListTry in Inspector
List history about your instances (audit) - List and filters the history about your instances.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| endDate | No | ||
| orderBy | No | ||
| changedBy | No | ||
| requestId | No | ||
| startDate | No | ||
| instanceId | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveInstancesListTry in Inspector
List instances - List and filter all instances in your account
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| page | No | ||
| size | No | ||
| region | No | ||
| search | No | ||
| status | No | ||
| orderBy | No | ||
| addOnIds | No | ||
| ipConfig | No | ||
| tenantId | No | ||
| customerId | No | ||
| dataCenter | No | ||
| instanceId | No | ||
| productIds | No | ||
| x-trace-id | No | ||
| displayName | No | ||
| instanceIds | No | ||
| productTypes | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveObjectStorageTry in Inspector
Get specific object storage by its id - Get data for a specific object storage on your account.
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| objectStorageId | Yes | ||
| x-hapi-auth-state | No |
retrieveObjectStorageAuditsListTry in Inspector
List history about your object storages (audit) - List and filters the history about your object storages.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| endDate | No | ||
| orderBy | No | ||
| changedBy | No | ||
| requestId | No | ||
| startDate | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| objectStorageId | No | ||
| x-hapi-auth-state | No |
retrieveObjectStorageListTry in Inspector
List all your object storages - List and filter all object storages in your account
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| region | No | ||
| orderBy | No | ||
| s3TenantId | No | ||
| x-trace-id | No | ||
| displayName | No | ||
| x-request-id | Yes | ||
| dataCenterName | No | ||
| x-hapi-auth-state | No |
retrieveObjectStoragesStatsTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| objectStorageId | Yes | ||
| x-hapi-auth-state | No |
retrievePrivateNetworkTry in Inspector
Get specific Private Network by id - Get attributes values to a specific Private Network on your account.
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| privateNetworkId | Yes | ||
| x-hapi-auth-state | No |
retrievePrivateNetworkAuditsListTry in Inspector
List history about your Private Networks (audit) - List and filters the history about your Private Networks.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| endDate | No | ||
| orderBy | No | ||
| changedBy | No | ||
| requestId | No | ||
| startDate | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| privateNetworkId | No | ||
| x-hapi-auth-state | No |
retrievePrivateNetworkListTry in Inspector
List Private Networks - List and filter all Private Networks in your account
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| page | No | ||
| size | No | ||
| region | No | ||
| orderBy | No | ||
| dataCenter | No | ||
| x-trace-id | No | ||
| instanceIds | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrievePtrRecordTry in Inspector
Retrieve a PTR Record by ip address - Get all attributes for a specific PTR Record
| Name | Required | Description | Default |
|---|---|---|---|
| ipAddress | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrievePtrRecordsListTry in Inspector
List PTR records - Get a list of all PTR records, either customer or a list of IPs is required
| Name | Required | Description | Default |
|---|---|---|---|
| ips | No | ||
| page | No | ||
| size | No | ||
| search | No | ||
| orderBy | No | ||
| tenantId | No | ||
| customerId | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveRecordAuditsListTry in Inspector
List history about your DNS Records (audit) - List and filter the history of changes made to your DNS Records.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| endDate | No | ||
| orderBy | No | ||
| recordId | No | ||
| changedBy | No | ||
| requestId | No | ||
| startDate | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveRoleTry in Inspector
Get specific role by id - Get attributes of specific role.
| Name | Required | Description | Default |
|---|---|---|---|
| roleId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveRoleAuditsListTry in Inspector
List history about your roles (audit) - List and filter the history about your roles.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| roleId | No | ||
| endDate | No | ||
| orderBy | No | ||
| changedBy | No | ||
| requestId | No | ||
| startDate | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveRoleListTry in Inspector
List roles - List and filter all your roles. A role allows you to specify permission to api endpoints and resources like compute.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| page | No | ||
| size | No | ||
| type | No | ||
| apiName | No | ||
| orderBy | No | ||
| tagName | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveSecretTry in Inspector
Get specific secret by id - Get attributes values for a specific secret on your account.
| Name | Required | Description | Default |
|---|---|---|---|
| secretId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveSecretAuditsListTry in Inspector
List history about your secrets (audit) - List and filters the history about your secrets.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| endDate | No | ||
| orderBy | No | ||
| secretId | No | ||
| changedBy | No | ||
| requestId | No | ||
| startDate | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveSecretListTry in Inspector
List secrets - List and filter all secrets in your account.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| page | No | ||
| size | No | ||
| type | No | ||
| orderBy | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveSnapshotTry in Inspector
Retrieve a specific snapshot by id - Get all attributes for a specific snapshot
| Name | Required | Description | Default |
|---|---|---|---|
| instanceId | Yes | ||
| snapshotId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveSnapshotListTry in Inspector
List snapshots - List and filter all your snapshots for a specific instance
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| page | No | ||
| size | No | ||
| orderBy | No | ||
| instanceId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveSnapshotsAuditsListTry in Inspector
List history about your snapshots (audit) triggered via the API - List and filters the history about your snapshots your triggered via the API.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| endDate | No | ||
| orderBy | No | ||
| changedBy | No | ||
| requestId | No | ||
| startDate | No | ||
| instanceId | No | ||
| snapshotId | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveTagTry in Inspector
Get specific tag by id - Get attributes values to a specific tag on your account.
| Name | Required | Description | Default |
|---|---|---|---|
| tagId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveTagAuditsListTry in Inspector
List history about your assignments (audit) - List and filters the history about your assignments.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| tagId | No | ||
| endDate | No | ||
| orderBy | No | ||
| changedBy | No | ||
| requestId | No | ||
| startDate | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveTagListTry in Inspector
List tags - List and filter all tags in your account
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| page | No | ||
| size | No | ||
| orderBy | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveUserTry in Inspector
Get specific user by id - Get attributes for a specific user.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveUserAuditsListTry in Inspector
List history about your users (audit) - List and filter the history about your users.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| userId | No | ||
| endDate | No | ||
| orderBy | No | ||
| changedBy | No | ||
| requestId | No | ||
| startDate | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveUserClientTry in Inspector
Get client - Get idm client.
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveUserIsPasswordSetTry in Inspector
Get user is password set status - Get info about idm user if the password is set.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveUserListTry in Inspector
List users - List and filter all your users.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| No | |||
| owner | No | ||
| enabled | No | ||
| orderBy | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveVipTry in Inspector
Get specific VIP by ip - Get attributes values to a specific VIP on your account.
| Name | Required | Description | Default |
|---|---|---|---|
| ip | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveVipAuditsListTry in Inspector
List history about your VIPs (audit) - List and filters the history about your VIPs.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| vipId | No | ||
| endDate | No | ||
| orderBy | No | ||
| changedBy | No | ||
| requestId | No | ||
| startDate | No | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
retrieveVipListTry in Inspector
List VIPs - List and filter all vips in your account
| Name | Required | Description | Default |
|---|---|---|---|
| ip | No | ||
| ips | No | ||
| page | No | ||
| size | No | ||
| type | No | ||
| region | No | ||
| orderBy | No | ||
| ipVersion | No | ||
| dataCenter | No | ||
| resourceId | No | ||
| x-trace-id | No | ||
| resourceName | No | ||
| resourceType | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No | ||
| resourceDisplayName | No |
revokeCancelDomainTry in Inspector
Revoke cancellation for a specific domain - Revoke cancellation for a specific domain
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
revokeDomainTransferOutTry in Inspector
Revoke transfer out for a domain - Revoke transfer out for a domain
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
rollbackSnapshotTry in Inspector
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
| Name | Required | Description | Default |
|---|---|---|---|
| instanceId | Yes | ||
| snapshotId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No | ||
| rollbackSnapshotBody | Yes |
setDefaultHandleTry in Inspector
Set default handle - Set default handle
| Name | Required | Description | Default |
|---|---|---|---|
| handleId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
shutdownTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| instanceId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
startTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| instanceId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
stopTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| instanceId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
unassignInstancePrivateNetworkTry in Inspector
Remove instance from a Private Network - Remove a specific instance from a Private Network
| Name | Required | Description | Default |
|---|---|---|---|
| instanceId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| privateNetworkId | Yes | ||
| x-hapi-auth-state | No |
unassignIpTry in Inspector
Unassign a VIP to a VPS/VDS/Bare Metal - Unassign a VIP from an VPS/VDS/Bare Metal using the machine id.
| Name | Required | Description | Default |
|---|---|---|---|
| ip | Yes | ||
| resourceId | Yes | ||
| x-trace-id | No | ||
| resourceType | Yes | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
updateDnsZoneRecordTry in Inspector
Update DNS zone record - Create resource record in a zone
| Name | Required | Description | Default |
|---|---|---|---|
| recordId | Yes | ||
| zoneName | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No | ||
| updateDnsZoneRecordBody | Yes |
updateDomainTry in Inspector
Update a specific domain - Update nameservers and handles for a specific domain
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| updateDomainBody | Yes | ||
| x-hapi-auth-state | No |
updateHandleTry in Inspector
Update specific handle - Update specific handle
| Name | Required | Description | Default |
|---|---|---|---|
| handleId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| updateHandleBody | Yes | ||
| x-hapi-auth-state | No |
updateImageTry in Inspector
Update custom image name by its id - Update name of the custom image
| Name | Required | Description | Default |
|---|---|---|---|
| imageId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| updateImageBody | Yes | ||
| x-hapi-auth-state | No |
updateObjectStorageTry in Inspector
Modifies the display name of object storage - Modifies the display name of object storage. Display name must be unique.
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| objectStorageId | Yes | ||
| x-hapi-auth-state | No | ||
| updateObjectStorageBody | Yes |
updatePtrRecordTry in Inspector
Edit a PTR Record by ip address - Edit attributes for a specific PTR Record
| Name | Required | Description | Default |
|---|---|---|---|
| ipAddress | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No | ||
| updatePtrRecordBody | Yes |
updateRoleTry in Inspector
Update specific role by id - Update attributes to your role. Attributes are optional. If not set, the attributes will retain their original values.
| Name | Required | Description | Default |
|---|---|---|---|
| roleId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| updateRoleBody | Yes | ||
| x-hapi-auth-state | No |
updateSecretTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| secretId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| updateSecretBody | Yes | ||
| x-hapi-auth-state | No |
updateSnapshotTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| instanceId | Yes | ||
| snapshotId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No | ||
| updateSnapshotBody | Yes |
updateTagTry in Inspector
Update specific tag by id - Update attributes to your tag. Attributes are optional. If not set, the attributes will retain their original values.
| Name | Required | Description | Default |
|---|---|---|---|
| tagId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| updateTagBody | Yes | ||
| x-hapi-auth-state | No |
updateUserTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| updateUserBody | Yes | ||
| x-hapi-auth-state | No |
upgradeInstanceTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| instanceId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No | ||
| upgradeInstanceBody | Yes |
upgradeObjectStorageTry in Inspector
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.
| Name | Required | Description | Default |
|---|---|---|---|
| x-trace-id | No | ||
| x-request-id | Yes | ||
| objectStorageId | Yes | ||
| x-hapi-auth-state | No | ||
| upgradeObjectStorageBody | Yes |
validateDomainAvailabilityTry in Inspector
Check domain availablility - Check if a specific domain is available or not
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes | ||
| x-hapi-auth-state | No |
FAQ
How do I claim this server?
To claim this server, publish a /.well-known/glama.json file on your server's domain with the following structure:
The email address must match the email associated with your Glama account. Once verified, the server will appear as claimed by you.
What are the benefits of claiming a server?
- Control your server's listing on Glama, including description and metadata
- Receive usage reports showing how your server is being used
- Get monitoring and health status updates for your server
Your Connectors
Sign in to create a connector for this server.