Contabo (VPS) MCP Server

Official124 toolsLive

by la-rebelion · HTML

Contabo API (v1.0.0) as MCP tools for cloud provisioning, and management. Powered by HAPI MCP server

The ai.com.mcp/contabo MCP server exposes Contabo API (v1.0.0) as MCP tools for cloud provisioning and management. It is powered by the HAPI MCP server, which lifts an OpenAPI catalog into MCP tools so API design and runtime integrations remain separated.

🛠️ Key Features

Contabo API (v1.0.0) converted into MCP tools for provisioning and management
Powered by HAPI MCP server
Lifts an OpenAPI catalog into MCP tools automatically, separating design (OAS/Arazzo) from runtime (agents/LLMs)
OpenAPI in, MCP tools out without creating a parallel codebase

🚀 Use Cases

Provisioning and managing cloud resources via MCP tools
Using existing OpenAPI-defined APIs as agent-ready tools

⚡ Developer Benefits

Reuse existing API logic from OpenAPI specs
Reduce duplication by avoiding parallel code or shadow services
Use updated API specifications to update tools at runtime

⚠️ Limitations

The provided information references HAPI MCP behavior and conversion approach, but does not specify other operational constraints.

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.

Parameters2

query	string	required	A regex pattern or natural-language query to search tool names, descriptions, and argument names. Maximum 200 characters.
mode	string	optional	Search mode: "regex" for pattern matching, "bm25" for natural language. Defaults to "bm25".

Raw schema

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

retrieveTagList

List tags - List and filter all tags in your account

Parameters6

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
name	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "name": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id"
  ]
}

createTag

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
createTagBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "createTagBody": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag."
        },
        "color": {
          "type": "string",
          "minLength": 4,
          "maxLength": 7,
          "description": "The color of the tag. Color can be specified using hexadecimal value. Default color is #0A78C3"
        },
        "description": {
          "type": "string",
          "description": "The description of the Tag name. "
        }
      },
      "required": [
        "name",
        "color"
      ]
    }
  },
  "required": [
    "x-request-id",
    "createTagBody"
  ]
}

retrieveTag

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
tagId	integer	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "tagId": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "x-request-id",
    "tagId"
  ]
}

updateTag

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

Parameters4

x-request-id	string	required
x-trace-id	string	optional
tagId	integer	required
updateTagBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "tagId": {
      "type": "integer",
      "format": "int64"
    },
    "updateTagBody": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag."
        },
        "color": {
          "type": "string",
          "minLength": 4,
          "maxLength": 7,
          "description": "The color of the tag. Color can be specified using hexadecimal value. Default color is #0A78C3"
        },
        "description": {
          "type": "string",
          "description": "The description of the Tag name. "
        }
      }
    }
  },
  "required": [
    "x-request-id",
    "tagId",
    "updateTagBody"
  ]
}

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.

Parameters3

x-request-id	string	required
x-trace-id	string	optional
tagId	integer	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "tagId": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "x-request-id",
    "tagId"
  ]
}

retrieveAssignmentList

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

Parameters7

x-request-id	string	required
x-trace-id	string	optional
tagId	integer	required
page	integer	optional
size	integer	optional
orderBy	array	optional
resourceType	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "tagId": {
      "type": "integer",
      "format": "int64"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "resourceType": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "tagId"
  ]
}

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.

Parameters5

x-request-id	string	required
x-trace-id	string	optional
tagId	integer	required
resourceType	string	required
resourceId	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "tagId": {
      "type": "integer",
      "format": "int64"
    },
    "resourceType": {
      "type": "string"
    },
    "resourceId": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "tagId",
    "resourceType",
    "resourceId"
  ]
}

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.

Parameters5

x-request-id	string	required
x-trace-id	string	optional
tagId	integer	required
resourceType	string	required
resourceId	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "tagId": {
      "type": "integer",
      "format": "int64"
    },
    "resourceType": {
      "type": "string"
    },
    "resourceId": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "tagId",
    "resourceType",
    "resourceId"
  ]
}

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.

Parameters5

x-request-id	string	required
x-trace-id	string	optional
tagId	integer	required
resourceType	string	required
resourceId	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "tagId": {
      "type": "integer",
      "format": "int64"
    },
    "resourceType": {
      "type": "string"
    },
    "resourceId": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "tagId",
    "resourceType",
    "resourceId"
  ]
}

retrieveTagAuditsList

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

Parameters10

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
tagId	integer	optional
requestId	string	optional
changedBy	string	optional
startDate	string	optional
endDate	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tagId": {
      "type": "integer",
      "format": "int64"
    },
    "requestId": {
      "type": "string"
    },
    "changedBy": {
      "type": "string"
    },
    "startDate": {
      "type": "string",
      "format": "date"
    },
    "endDate": {
      "type": "string",
      "format": "date"
    }
  },
  "required": [
    "x-request-id"
  ]
}

retrieveAssignmentsAuditsList

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

Parameters11

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
tagId	integer	optional
resourceId	string	optional
requestId	string	optional
changedBy	string	optional
startDate	string	optional
endDate	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tagId": {
      "type": "integer",
      "format": "int64"
    },
    "resourceId": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "changedBy": {
      "type": "string"
    },
    "startDate": {
      "type": "string",
      "format": "date"
    },
    "endDate": {
      "type": "string",
      "format": "date"
    }
  },
  "required": [
    "x-request-id"
  ]
}

retrievePtrRecord

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
ipAddress	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "ipAddress": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "ipAddress"
  ]
}

updatePtrRecord

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

Parameters4

x-request-id	string	required
x-trace-id	string	optional
ipAddress	string	required
updatePtrRecordBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "ipAddress": {
      "type": "string"
    },
    "updatePtrRecordBody": {
      "type": "object",
      "properties": {
        "ptr": {
          "type": "string",
          "description": "PTR Record name"
        }
      },
      "required": [
        "ptr"
      ]
    }
  },
  "required": [
    "x-request-id",
    "ipAddress",
    "updatePtrRecordBody"
  ]
}

deletePtrRecord

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
ipAddress	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "ipAddress": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "ipAddress"
  ]
}

createPtrRecord

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
createPtrRecordBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "createPtrRecordBody": {
      "type": "object",
      "properties": {
        "ptr": {
          "type": "string",
          "description": "PTR Record name"
        },
        "ip": {
          "type": "string",
          "description": "IP Address"
        },
        "ttl": {
          "type": "integer",
          "format": "int64",
          "description": "Time to live for the PTR record in seconds"
        }
      },
      "required": [
        "ptr",
        "ip",
        "ttl"
      ]
    }
  },
  "required": [
    "x-request-id",
    "createPtrRecordBody"
  ]
}

retrievePtrRecordsList

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

Parameters9

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
customerId	string	optional
tenantId	string	optional
ips	array	optional
search	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "customerId": {
      "type": "string"
    },
    "tenantId": {
      "type": "string",
      "enum": [
        "DE",
        "INT"
      ]
    },
    "ips": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "search": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id"
  ]
}

retrieveDnsZonesList

List DNS zones - Get a list of all zones

Parameters8

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
customerId	string	optional
tenantId	string	optional
zoneName	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "customerId": {
      "type": "string"
    },
    "tenantId": {
      "type": "string",
      "enum": [
        "DE",
        "INT"
      ]
    },
    "zoneName": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id"
  ]
}

createDnsZone

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
createDnsZoneBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "createDnsZoneBody": {
      "type": "object",
      "properties": {
        "zoneName": {
          "type": "string",
          "description": "Zone name"
        }
      },
      "required": [
        "zoneName"
      ]
    }
  },
  "required": [
    "x-request-id",
    "createDnsZoneBody"
  ]
}

retrieveDnsZone

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
zoneName	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "zoneName": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "zoneName"
  ]
}

deleteDnsZone

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
zoneName	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "zoneName": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "zoneName"
  ]
}

retrieveDnsZoneRecordsList

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

Parameters7

x-request-id	string	required
x-trace-id	string	optional
zoneName	string	required
page	integer	optional
size	integer	optional
orderBy	array	optional
search	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "zoneName": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "search": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "zoneName"
  ]
}

createDnsZoneRecord

Create DNS zone record - Create resource record in a zone

Parameters4

x-request-id	string	required
x-trace-id	string	optional
zoneName	string	required
createDnsZoneRecordBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "zoneName": {
      "type": "string"
    },
    "createDnsZoneRecordBody": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "description": "Name, if empty the zone name will be used"
        },
        "type": {
          "type": "string",
          "minLength": 1,
          "description": "Type"
        },
        "ttl": {
          "type": "number",
          "description": "TTL"
        },
        "prio": {
          "type": "number",
          "description": "Prio"
        },
        "data": {
          "type": "string",
          "minLength": 1,
          "description": "Data"
        },
        "port": {
          "type": "number",
          "description": "Port"
        },
        "weight": {
          "type": "number",
          "description": "Weight"
        },
        "flag": {
          "type": "number",
          "description": "Flag"
        },
        "tag": {
          "type": "string",
          "description": "Tag"
        }
      },
      "required": [
        "type",
        "ttl",
        "prio",
        "data"
      ]
    }
  },
  "required": [
    "x-request-id",
    "zoneName",
    "createDnsZoneRecordBody"
  ]
}

updateDnsZoneRecord

Update DNS zone record - Create resource record in a zone

Parameters5

x-request-id	string	required
x-trace-id	string	optional
recordId	integer	required
zoneName	string	required
updateDnsZoneRecordBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "recordId": {
      "type": "integer",
      "format": "int64"
    },
    "zoneName": {
      "type": "string"
    },
    "updateDnsZoneRecordBody": {
      "type": "object",
      "properties": {
        "ttl": {
          "type": "number",
          "description": "TTL"
        },
        "prio": {
          "type": "number",
          "description": "Prio"
        },
        "data": {
          "type": "string",
          "minLength": 1,
          "description": "Data"
        },
        "port": {
          "type": "number",
          "description": "Port"
        },
        "weight": {
          "type": "number",
          "description": "Weight"
        },
        "flag": {
          "type": "number",
          "description": "Flag"
        },
        "tag": {
          "type": "string",
          "description": "Tag"
        }
      },
      "required": [
        "ttl",
        "prio",
        "data"
      ]
    }
  },
  "required": [
    "x-request-id",
    "recordId",
    "zoneName",
    "updateDnsZoneRecordBody"
  ]
}

deleteDnsZoneRecord

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

Parameters4

x-request-id	string	required
x-trace-id	string	optional
recordId	integer	required
zoneName	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "recordId": {
      "type": "integer",
      "format": "int64"
    },
    "zoneName": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "recordId",
    "zoneName"
  ]
}

bulkDeleteDnsZoneRecords

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

Parameters4

x-request-id	string	required
x-trace-id	string	optional
zoneName	string	required
bulkDeleteDnsZoneRecordsBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "zoneName": {
      "type": "string"
    },
    "bulkDeleteDnsZoneRecordsBody": {
      "type": "object",
      "properties": {
        "recordIds": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "List of zone record ids to delete"
        }
      },
      "required": [
        "recordIds"
      ]
    }
  },
  "required": [
    "x-request-id",
    "zoneName",
    "bulkDeleteDnsZoneRecordsBody"
  ]
}

retrieveImageAuditsList

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

Parameters10

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
name	string	optional
requestId	string	optional
changedBy	string	optional
startDate	string	optional
endDate	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "name": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "changedBy": {
      "type": "string"
    },
    "startDate": {
      "type": "string",
      "format": "date"
    },
    "endDate": {
      "type": "string",
      "format": "date"
    }
  },
  "required": [
    "x-request-id"
  ]
}

retrieveRecordAuditsList

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

Parameters10

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
recordId	integer	optional
requestId	string	optional
changedBy	string	optional
startDate	string	optional
endDate	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "recordId": {
      "type": "integer",
      "format": "int64"
    },
    "requestId": {
      "type": "string"
    },
    "changedBy": {
      "type": "string"
    },
    "startDate": {
      "type": "string",
      "format": "date"
    },
    "endDate": {
      "type": "string",
      "format": "date"
    }
  },
  "required": [
    "x-request-id"
  ]
}

retrieveVipList

List VIPs - List and filter all vips in your account

Parameters15

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
resourceId	string	optional
resourceType	string	optional
resourceName	string	optional
resourceDisplayName	string	optional
ipVersion	string	optional
ips	string	optional
ip	string	optional
type	string	optional
dataCenter	string	optional
region	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "resourceId": {
      "type": "string"
    },
    "resourceType": {
      "type": "string",
      "enum": [
        "instances",
        "bare-metal",
        "null"
      ]
    },
    "resourceName": {
      "type": "string"
    },
    "resourceDisplayName": {
      "type": "string"
    },
    "ipVersion": {
      "type": "string",
      "enum": [
        "v4"
      ]
    },
    "ips": {
      "type": "string"
    },
    "ip": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "enum": [
        "additional",
        "floating"
      ]
    },
    "dataCenter": {
      "type": "string"
    },
    "region": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id"
  ]
}

retrieveVip

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
ip	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "ip": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "ip"
  ]
}

assignIp

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

Parameters5

x-request-id	string	required
x-trace-id	string	optional
resourceId	integer	required
ip	string	required
resourceType	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "resourceId": {
      "type": "integer",
      "format": "int64"
    },
    "ip": {
      "type": "string"
    },
    "resourceType": {
      "type": "string",
      "enum": [
        "instances",
        "bare-metal"
      ]
    }
  },
  "required": [
    "x-request-id",
    "resourceId",
    "ip",
    "resourceType"
  ]
}

unassignIp

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

Parameters5

x-request-id	string	required
x-trace-id	string	optional
resourceId	integer	required
ip	string	required
resourceType	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "resourceId": {
      "type": "integer",
      "format": "int64"
    },
    "ip": {
      "type": "string"
    },
    "resourceType": {
      "type": "string",
      "enum": [
        "instances",
        "bare-metal"
      ]
    }
  },
  "required": [
    "x-request-id",
    "resourceId",
    "ip",
    "resourceType"
  ]
}

retrieveVipAuditsList

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

Parameters10

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
vipId	string	optional
requestId	string	optional
changedBy	string	optional
startDate	string	optional
endDate	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "vipId": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "changedBy": {
      "type": "string"
    },
    "startDate": {
      "type": "string",
      "format": "date"
    },
    "endDate": {
      "type": "string",
      "format": "date"
    }
  },
  "required": [
    "x-request-id"
  ]
}

retrieveSecretList

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

Parameters7

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
name	string	optional
type	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "enum": [
        "password",
        "ssh"
      ]
    }
  },
  "required": [
    "x-request-id"
  ]
}

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.

Parameters3

x-request-id	string	required
x-trace-id	string	optional
createSecretBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "createSecretBody": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The name of the secret that will keep the password"
        },
        "value": {
          "type": "string",
          "minLength": 8,
          "description": "The secret value that needs to be saved. In case of a password it must match a pattern with at least one upper and lower case character and either one number with two special characters `!@#$^&*?_~` or at least three numbers with one special character `!@#$^&*?_~`. This is expressed in the following regular expression: `^((?=.*?[A-Z]{1,})(?=.*?[a-z]{1,}))(((?=(?:[^d]*d){1})(?=([^^&*?_~]*[!@#$^&*?_~]){2,}))|((?=(?:[^d]*d){3})(?=.*?[!@#$^&*?_~]+))).{8,}$`"
        },
        "type": {
          "type": "string",
          "enum": [
            "password",
            "ssh"
          ],
          "description": "The type of the secret. Can be `password` or `ssh`"
        }
      },
      "required": [
        "name",
        "value",
        "type"
      ]
    }
  },
  "required": [
    "x-request-id",
    "createSecretBody"
  ]
}

retrieveSecret

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
secretId	integer	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "secretId": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "x-request-id",
    "secretId"
  ]
}

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.

Parameters4

x-request-id	string	required
x-trace-id	string	optional
secretId	integer	required
updateSecretBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "secretId": {
      "type": "integer",
      "format": "int64"
    },
    "updateSecretBody": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the secret to be saved"
        },
        "value": {
          "type": "string",
          "minLength": 8,
          "description": "The value of the secret to be saved"
        }
      }
    }
  },
  "required": [
    "x-request-id",
    "secretId",
    "updateSecretBody"
  ]
}

deleteSecret

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
secretId	integer	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "secretId": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "x-request-id",
    "secretId"
  ]
}

retrieveSecretAuditsList

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

Parameters10

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
secretId	integer	optional
requestId	string	optional
changedBy	string	optional
startDate	string	optional
endDate	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "secretId": {
      "type": "integer",
      "format": "int64"
    },
    "requestId": {
      "type": "string"
    },
    "changedBy": {
      "type": "string"
    },
    "startDate": {
      "type": "string",
      "format": "date"
    },
    "endDate": {
      "type": "string",
      "format": "date"
    }
  },
  "required": [
    "x-request-id"
  ]
}

retrievePrivateNetworkList

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

Parameters9

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
name	string	optional
instanceIds	string	optional
region	string	optional
dataCenter	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "name": {
      "type": "string"
    },
    "instanceIds": {
      "type": "string"
    },
    "region": {
      "type": "string"
    },
    "dataCenter": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id"
  ]
}

createPrivateNetwork

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
createPrivateNetworkBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "createPrivateNetworkBody": {
      "type": "object",
      "properties": {
        "region": {
          "type": "string",
          "minLength": 1,
          "description": "Region where the Private Network should be located. Default is `EU`"
        },
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The name of the Private Network. It may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per Private Network name."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "The description of the Private Network. There is a limit of 255 characters per Private Network description."
        }
      },
      "required": [
        "name"
      ]
    }
  },
  "required": [
    "x-request-id",
    "createPrivateNetworkBody"
  ]
}

patchPrivateNetwork

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

Parameters4

x-request-id	string	required
x-trace-id	string	optional
privateNetworkId	integer	required
patchPrivateNetworkBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "privateNetworkId": {
      "type": "integer",
      "format": "int64"
    },
    "patchPrivateNetworkBody": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The name of the Private Network. It may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per Private Network."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "The description of the Private Network. There is a limit of 255 characters per Private Network."
        }
      }
    }
  },
  "required": [
    "x-request-id",
    "privateNetworkId",
    "patchPrivateNetworkBody"
  ]
}

retrievePrivateNetwork

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
privateNetworkId	integer	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "privateNetworkId": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "x-request-id",
    "privateNetworkId"
  ]
}

deletePrivateNetwork

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
privateNetworkId	integer	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "privateNetworkId": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "x-request-id",
    "privateNetworkId"
  ]
}

assignInstancePrivateNetwork

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

Parameters4

x-request-id	string	required
x-trace-id	string	optional
privateNetworkId	integer	required
instanceId	integer	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "privateNetworkId": {
      "type": "integer",
      "format": "int64"
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "x-request-id",
    "privateNetworkId",
    "instanceId"
  ]
}

unassignInstancePrivateNetwork

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

Parameters4

x-request-id	string	required
x-trace-id	string	optional
privateNetworkId	integer	required
instanceId	integer	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "privateNetworkId": {
      "type": "integer",
      "format": "int64"
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "x-request-id",
    "privateNetworkId",
    "instanceId"
  ]
}

retrievePrivateNetworkAuditsList

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

Parameters10

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
privateNetworkId	integer	optional
requestId	string	optional
changedBy	string	optional
startDate	string	optional
endDate	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "privateNetworkId": {
      "type": "integer",
      "format": "int64"
    },
    "requestId": {
      "type": "string"
    },
    "changedBy": {
      "type": "string"
    },
    "startDate": {
      "type": "string",
      "format": "date"
    },
    "endDate": {
      "type": "string",
      "format": "date"
    }
  },
  "required": [
    "x-request-id"
  ]
}

retrieveUserList

List users - List and filter all your users.

Parameters8

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
email	string	optional
enabled	boolean	optional
owner	boolean	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "email": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "owner": {
      "type": "boolean"
    }
  },
  "required": [
    "x-request-id"
  ]
}

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.

Parameters3

x-request-id	string	required
x-trace-id	string	optional
createUserBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "createUserBody": {
      "type": "object",
      "properties": {
        "firstName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The name of the user. Names may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per user."
        },
        "lastName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The last name of the user. Users may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per user."
        },
        "email": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The email of the user to which activation and forgot password links are being sent to. There is a limit of 255 characters per email."
        },
        "enabled": {
          "type": "boolean",
          "description": "If user is not enabled, he can't login and thus use services any longer."
        },
        "totp": {
          "type": "boolean",
          "description": "Enable or disable two-factor authentication (2FA) via time based OTP."
        },
        "locale": {
          "type": "string",
          "enum": [
            "de-DE",
            "de",
            "en-US",
            "en",
            "es",
            "es-ES",
            "pt-BR",
            "pt"
          ],
          "description": "The locale of the user. This can be `de-DE`, `de`, `en-US`, `en`, `es-ES`, `es`, `pt-BR`, `pt`."
        },
        "roles": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "The roles as list of `roleId`s of the user."
        }
      },
      "required": [
        "email",
        "enabled",
        "totp",
        "locale"
      ]
    }
  },
  "required": [
    "x-request-id",
    "createUserBody"
  ]
}

retrieveUser

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
userId	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "userId": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "userId"
  ]
}

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.

Parameters4

x-request-id	string	required
x-trace-id	string	optional
userId	string	required
updateUserBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "userId": {
      "type": "string"
    },
    "updateUserBody": {
      "type": "object",
      "properties": {
        "firstName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The name of the user. Names may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per user."
        },
        "lastName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The last name of the user. Users may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per user."
        },
        "email": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The email of the user to which activation and forgot password links are being sent to. There is a limit of 255 characters per email."
        },
        "enabled": {
          "type": "boolean",
          "description": "If user is not enabled, he can't login and thus use services any longer."
        },
        "totp": {
          "type": "boolean",
          "description": "Enable or disable two-factor authentication (2FA) via time based OTP."
        },
        "locale": {
          "type": "string",
          "enum": [
            "de-DE",
            "de",
            "en-US",
            "en",
            "es",
            "es-ES",
            "pt-BR",
            "pt"
          ],
          "description": "The locale of the user. This can be `de-DE`, `de`, `en-US`, `en`, `es-ES`, `es`, `pt-BR`, `pt`."
        },
        "roles": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "The roles as list of `roleId`s of the user."
        }
      }
    }
  },
  "required": [
    "x-request-id",
    "userId",
    "updateUserBody"
  ]
}

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.

Parameters3

x-request-id	string	required
x-trace-id	string	optional
userId	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "userId": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "userId"
  ]
}

resetPassword

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

Parameters4

x-request-id	string	required
x-trace-id	string	optional
userId	string	required
redirectUrl	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "userId": {
      "type": "string"
    },
    "redirectUrl": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "userId"
  ]
}

resendEmailVerification

Resend email verification - Resend email verification for a specific user

Parameters4

x-request-id	string	required
x-trace-id	string	optional
userId	string	required
redirectUrl	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "userId": {
      "type": "string"
    },
    "redirectUrl": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "userId"
  ]
}

retrieveUserClient

Get client - Get idm client.

Parameters2

x-request-id	string	required
x-trace-id	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id"
  ]
}

generateClientSecret

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

Parameters2

x-request-id	string	required
x-trace-id	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id"
  ]
}

retrieveUserIsPasswordSet

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
userId	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "userId": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id"
  ]
}

retrieveRoleList

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

Parameters9

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
name	string	optional
apiName	string	optional
tagName	string	optional
type	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "name": {
      "type": "string"
    },
    "apiName": {
      "type": "string"
    },
    "tagName": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id"
  ]
}

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.

Parameters3

x-request-id	string	required
x-trace-id	string	optional
createRoleBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "createRoleBody": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The name of the role. There is a limit of 255 characters per role."
        },
        "admin": {
          "type": "boolean",
          "description": "If user is admin he will have permissions to all API endpoints and resources. Enabling this will superseed all role definitions and `accessAllResources`."
        },
        "accessAllResources": {
          "type": "boolean",
          "description": "Allow access to all resources. This will superseed all assigned resources in a role."
        },
        "permissions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "apiName": {
                "type": "string",
                "minLength": 1,
                "maxLength": 255,
                "description": "The name of the role. There is a limit of 255 characters per role."
              },
              "actions": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "CREATE",
                    "READ",
                    "UPDATE",
                    "DELETE"
                  ]
                },
                "description": "Action allowed for the API endpoint. Basically `CREATE` corresponds to POST endpoints, `READ` to GET endpoints, `UPDATE` to PATCH / PUT endpoints and `DELETE` to DELETE endpoints."
              },
              "resources": {
                "type": "array",
                "items": {
                  "type": "integer",
                  "format": "int64"
                },
                "description": "The IDs of tags. Only if those tags are assgined to a resource the user with that role will be able to access the resource."
              }
            },
            "required": [
              "apiName",
              "actions"
            ]
          }
        }
      },
      "required": [
        "name",
        "admin",
        "accessAllResources"
      ]
    }
  },
  "required": [
    "x-request-id",
    "createRoleBody"
  ]
}

retrieveRole

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
roleId	integer	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "roleId": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "x-request-id",
    "roleId"
  ]
}

updateRole

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

Parameters4

x-request-id	string	required
x-trace-id	string	optional
roleId	integer	required
updateRoleBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "roleId": {
      "type": "integer",
      "format": "int64"
    },
    "updateRoleBody": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The name of the role. There is a limit of 255 characters per role."
        },
        "admin": {
          "type": "boolean",
          "description": "If user is admin he will have permissions to all API endpoints and resources. Enabling this will superseed all role definitions and `accessAllResources`."
        },
        "accessAllResources": {
          "type": "boolean",
          "description": "Allow access to all resources. This will superseed all assigned resources in a role."
        },
        "permissions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "apiName": {
                "type": "string",
                "minLength": 1,
                "maxLength": 255,
                "description": "The name of the role. There is a limit of 255 characters per role."
              },
              "actions": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "CREATE",
                    "READ",
                    "UPDATE",
                    "DELETE"
                  ]
                },
                "description": "Action allowed for the API endpoint. Basically `CREATE` corresponds to POST endpoints, `READ` to GET endpoints, `UPDATE` to PATCH / PUT endpoints and `DELETE` to DELETE endpoints."
              },
              "resources": {
                "type": "array",
                "items": {
                  "type": "integer",
                  "format": "int64"
                },
                "description": "The IDs of tags. Only if those tags are assgined to a resource the user with that role will be able to access the resource."
              }
            },
            "required": [
              "apiName",
              "actions"
            ]
          }
        }
      },
      "required": [
        "name",
        "admin",
        "accessAllResources"
      ]
    }
  },
  "required": [
    "x-request-id",
    "roleId",
    "updateRoleBody"
  ]
}

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.

Parameters3

x-request-id	string	required
x-trace-id	string	optional
roleId	integer	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "roleId": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "x-request-id",
    "roleId"
  ]
}

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.

Parameters6

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
apiName	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "apiName": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id"
  ]
}

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.

Parameters9

x-request-id	string	required
x-trace-id	string	optional
userId	string	required
page	integer	optional
size	integer	optional
orderBy	array	optional
objectStorageId	string	optional
regionName	string	optional
displayName	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "userId": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "objectStorageId": {
      "type": "string"
    },
    "regionName": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "userId"
  ]
}

getObjectStorageCredentials

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

Parameters5

x-request-id	string	required
x-trace-id	string	optional
userId	string	required
objectStorageId	string	required
credentialId	integer	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "userId": {
      "type": "string"
    },
    "objectStorageId": {
      "type": "string"
    },
    "credentialId": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "x-request-id",
    "userId",
    "objectStorageId",
    "credentialId"
  ]
}

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.

Parameters5

x-request-id	string	required
x-trace-id	string	optional
userId	string	required
objectStorageId	string	required
credentialId	integer	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "userId": {
      "type": "string"
    },
    "objectStorageId": {
      "type": "string"
    },
    "credentialId": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "x-request-id",
    "userId",
    "objectStorageId",
    "credentialId"
  ]
}

retrieveUserAuditsList

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

Parameters10

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
userId	string	optional
requestId	string	optional
changedBy	string	optional
startDate	string	optional
endDate	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "userId": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "changedBy": {
      "type": "string"
    },
    "startDate": {
      "type": "string",
      "format": "date"
    },
    "endDate": {
      "type": "string",
      "format": "date"
    }
  },
  "required": [
    "x-request-id"
  ]
}

retrieveRoleAuditsList

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

Parameters10

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
roleId	integer	optional
requestId	string	optional
changedBy	string	optional
startDate	string	optional
endDate	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "roleId": {
      "type": "integer",
      "format": "int64"
    },
    "requestId": {
      "type": "string"
    },
    "changedBy": {
      "type": "string"
    },
    "startDate": {
      "type": "string",
      "format": "date"
    },
    "endDate": {
      "type": "string",
      "format": "date"
    }
  },
  "required": [
    "x-request-id"
  ]
}

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.

Parameters3

x-request-id	string	required
x-trace-id	string	optional
instanceId	integer	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "x-request-id",
    "instanceId"
  ]
}

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.

Parameters3

x-request-id	string	required
x-trace-id	string	optional
instanceId	integer	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "x-request-id",
    "instanceId"
  ]
}

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.

Parameters3

x-request-id	string	required
x-trace-id	string	optional
instanceId	integer	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "x-request-id",
    "instanceId"
  ]
}

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.

Parameters3

x-request-id	string	required
x-trace-id	string	optional
instanceId	integer	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "x-request-id",
    "instanceId"
  ]
}

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.

Parameters4

x-request-id	string	required
x-trace-id	string	optional
instanceId	integer	required
rescueBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    },
    "rescueBody": {
      "type": "object",
      "properties": {
        "rootPassword": {
          "type": "integer",
          "format": "int64",
          "description": "`secretId` of the password to login into rescue system for the `root` user."
        },
        "sshKeys": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "Array of `secretId`s of public SSH keys for logging into rescue system as `root` user."
        },
        "userData": {
          "type": "string",
          "description": "[Cloud-Init](https://cloud-init.io/) Config in order to customize during start of compute instance."
        }
      }
    }
  },
  "required": [
    "x-request-id",
    "instanceId",
    "rescueBody"
  ]
}

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.

Parameters4

x-request-id	string	required
x-trace-id	string	optional
instanceId	integer	required
resetPasswordActionBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    },
    "resetPasswordActionBody": {
      "type": "object",
      "properties": {
        "sshKeys": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "Array of `secretId`s of public SSH keys for logging into as `defaultUser` with administrator/root privileges. Applies to Linux/BSD systems. Please refer to Secrets Management API."
        },
        "rootPassword": {
          "type": "integer",
          "format": "int64",
          "description": "`secretId` of the password for the `defaultUser` with administrator/root privileges. For Linux/BSD please use SSH, for Windows RDP. Please refer to Secrets Management API."
        },
        "userData": {
          "type": "string",
          "description": "[Cloud-Init](https://cloud-init.io/) Config in order to customize during start of compute instance."
        }
      }
    }
  },
  "required": [
    "x-request-id",
    "instanceId",
    "resetPasswordActionBody"
  ]
}

retrieveInstancesList

List instances - List and filter all instances in your account

Parameters19

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
name	string	optional
displayName	string	optional
dataCenter	string	optional
region	string	optional
instanceId	integer	optional
instanceIds	string	optional
status	string	optional
productIds	string	optional
addOnIds	string	optional
productTypes	string	optional
ipConfig	boolean	optional
search	string	optional
customerId	string	optional
tenantId	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "name": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "dataCenter": {
      "type": "string"
    },
    "region": {
      "type": "string"
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    },
    "instanceIds": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "provisioning",
        "uninstalled",
        "running",
        "stopped",
        "error",
        "installing",
        "unknown",
        "manual_provisioning",
        "product_not_available",
        "verification_required",
        "rescue",
        "pending_payment",
        "other",
        "reset_password"
      ]
    },
    "productIds": {
      "type": "string"
    },
    "addOnIds": {
      "type": "string"
    },
    "productTypes": {
      "type": "string"
    },
    "ipConfig": {
      "type": "boolean"
    },
    "search": {
      "type": "string"
    },
    "customerId": {
      "type": "string"
    },
    "tenantId": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id"
  ]
}

createInstance

Create a new instance - Create a new instance for your account with the provided parameters. <table> <tr><th>ProductId</th><th>Product</th><th>Disk Size</th></tr> <tr><td>V91</td><td>VPS 10 NVMe</td><td>75 GB NVMe</td></tr> <tr><td>V92</td><td>VPS 10 SSD</td><td>150 GB SSD</td></tr> <tr><td>V93</td><td>VPS 10 Storage</td><td>300 GB SSD</td></tr> <tr><td>V94</td><td>VPS 20 NVMe</td><td>100 GB NVMe</td></tr> <tr><td>V95</td><td>VPS 20 SSD</td><td>200 GB SSD</td></tr> <tr><td>V96</td><td>VPS 20 Storage</td><td>400 GB SSD</td></tr> <tr><td>V97</td><td>VPS 30 NVMe</td><td>200 GB NVMe</td></tr> <tr><td>V98</td><td>VPS 30 SSD</td><td>400 GB SSD</td></tr> <tr><td>V99</td><td>VPS 30 Storage</td><td>1000 GB NVMe</td></tr> <tr><td>V100</td><td>VPS 40 NVMe</td><td>250 GB NVMe</td></tr> <tr><td>V101</td><td>VPS 40 SSD</td><td>500 GB SSD</td></tr> <tr><td>V102</td><td>VPS 40 Storage</td><td>1200 GB NVMe</td></tr> <tr><td>V103</td><td>VPS 50 NVMe</td><td>300 GB NVMe</td></tr> <tr><td>V104</td><td>VPS 50 SSD</td><td>600 GB SSD</td></tr> <tr><td>V105</td><td>VPS 50 Storage</td><td>1400 GB SSD</td></tr> <tr><td>V106</td><td>VPS 60 NVMe</td><td>350 GB NVMe</td></tr> <tr><td>V107</td><td>VPS 60 SSD</td><td>700 GB SSD</td></tr> <tr><td>V8</td><td>VDS S</td><td>180 GB NVMe</td></tr> <tr><td>V9</td><td>VDS M</td><td>240 GB NVMe</td></tr> <tr><td>V10</td><td>VDS L</td><td>360 GB NVMe</td></tr> <tr><td>V11</td><td>VDS XL</td><td>480 GB NVMe</td></tr> <tr><td>V16</td><td>VDS XXL</td><td>720 GB NVMe</td></tr> </table>

Parameters3

x-request-id	string	required
x-trace-id	string	optional
createInstanceBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "createInstanceBody": {
      "type": "object",
      "properties": {
        "imageId": {
          "type": "string",
          "description": "ImageId to be used to setup the compute instance. Default is Ubuntu 22.04"
        },
        "productId": {
          "type": "string",
          "minLength": 1,
          "description": "Default is V92"
        },
        "region": {
          "type": "string",
          "minLength": 1,
          "enum": [
            "EU",
            "US-central",
            "US-east",
            "US-west",
            "SIN",
            "UK",
            "AUS",
            "JPN",
            "IND"
          ],
          "description": "Instance Region where the compute instance should be located. Default is EU"
        },
        "sshKeys": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "Array of `secretId`s of public SSH keys for logging into as `defaultUser` with administrator/root privileges. Applies to Linux/BSD systems. Please refer to Secrets Management API."
        },
        "rootPassword": {
          "type": "integer",
          "format": "int64",
          "description": "`secretId` of the password for the `defaultUser` with administrator/root privileges. For Linux/BSD please use SSH, for Windows RDP. Please refer to Secrets Management API."
        },
        "userData": {
          "type": "string",
          "description": "[Cloud-Init](https://cloud-init.io/) Config in order to customize during start of compute instance."
        },
        "license": {
          "type": "string",
          "enum": [
            "cPanel5",
            "cPanel30",
            "cPanel50",
            "cPanel100",
            "cPanel150",
            "cPanel200",
            "cPanel250",
            "cPanel300",
            "cPanel350",
            "cPanel400",
            "cPanel450",
            "cPanel500",
            "cPanel550",
            "cPanel600",
            "cPanel650",
            "cPanel700",
            "cPanel750",
            "cPanel800",
            "cPanel850",
            "cPanel900",
            "cPanel950",
            "cPanel1000",
            "PleskAdmin",
            "PleskHost",
            "PleskPro"
          ],
          "description": "Additional licence in order to enhance your chosen product, mainly needed for software licenses on your product (not needed for windows)."
        },
        "period": {
          "type": "integer",
          "format": "int64",
          "description": "Initial contract period in months. Available periods are: 1, 3, 6 and 12 months. Default to 1 month"
        },
        "displayName": {
          "type": "string",
          "maxLength": 255,
          "description": "The display name of the instance"
        },
        "defaultUser": {
          "type": "string",
          "enum": [
            "root",
            "admin",
            "administrator"
          ],
          "description": "Default user name created for login during (re-)installation with administrative privileges. Allowed values for Linux/BSD are `admin` (use sudo to apply administrative privileges like root) or `root`. Allowed values for Windows are `admin` (has administrative privileges like administrator) or `administrator`."
        },
        "addOns": {
          "type": "string",
          "description": "Set attributes in the addons object for the corresponding ones that need to be added to the instance"
        },
        "applicationId": {
          "type": "string",
          "description": "Application ID"
        }
      },
      "required": [
        "period"
      ]
    }
  },
  "required": [
    "x-request-id",
    "createInstanceBody"
  ]
}

retrieveInstance

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
instanceId	integer	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "x-request-id",
    "instanceId"
  ]
}

patchInstance

Update specific instance - Update specific instance by instanceId.

Parameters4

x-request-id	string	required
x-trace-id	string	optional
instanceId	integer	required
patchInstanceBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    },
    "patchInstanceBody": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "maxLength": 255,
          "description": "The display name of the instance"
        }
      }
    }
  },
  "required": [
    "x-request-id",
    "instanceId",
    "patchInstanceBody"
  ]
}

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.

Parameters4

x-request-id	string	required
x-trace-id	string	optional
instanceId	integer	required
reinstallInstanceBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    },
    "reinstallInstanceBody": {
      "type": "object",
      "properties": {
        "imageId": {
          "type": "string",
          "description": "ImageId to be used to setup the compute instance."
        },
        "sshKeys": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "Array of `secretId`s of public SSH keys for logging into as `defaultUser` with administrator/root privileges. Applies to Linux/BSD systems. Please refer to Secrets Management API."
        },
        "rootPassword": {
          "type": "integer",
          "format": "int64",
          "description": "`secretId` of the password for the `defaultUser` with administrator/root privileges. For Linux/BSD please use SSH, for Windows RDP. Please refer to Secrets Management API."
        },
        "userData": {
          "type": "string",
          "description": "[Cloud-Init](https://cloud-init.io/) Config in order to customize during start of compute instance."
        },
        "defaultUser": {
          "type": "string",
          "enum": [
            "root",
            "admin",
            "administrator"
          ],
          "description": "Default user name created for login during (re-)installation with administrative privileges. Allowed values for Linux/BSD are `admin` (use sudo to apply administrative privileges like root) or `root`. Allowed values for Windows are `admin` (has administrative privileges like administrator) or `administrator`."
        },
        "applicationId": {
          "type": "string",
          "description": "Application ID"
        }
      },
      "required": [
        "imageId"
      ]
    }
  },
  "required": [
    "x-request-id",
    "instanceId",
    "reinstallInstanceBody"
  ]
}

cancelInstance

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

Parameters4

x-request-id	string	required
x-trace-id	string	optional
instanceId	integer	required
cancelInstanceBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    },
    "cancelInstanceBody": {
      "type": "object",
      "properties": {
        "cancelDate": {
          "type": "string",
          "format": "date-time",
          "description": "Date of cancellation"
        }
      }
    }
  },
  "required": [
    "x-request-id",
    "instanceId",
    "cancelInstanceBody"
  ]
}

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.

Parameters4

x-request-id	string	required
x-trace-id	string	optional
instanceId	integer	required
upgradeInstanceBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    },
    "upgradeInstanceBody": {
      "type": "object",
      "properties": {
        "privateNetworking": {
          "type": "string",
          "description": "Set this attribute if you want to upgrade your instance with the Private Networking addon. Please provide an empty object for the time being as value. There will be more configuration possible in the future."
        },
        "backup": {
          "type": "string",
          "description": "Set this attribute if you want to upgrade your instance with the Automated Backup addon.   Please provide an empty object for the time being as value. There will be more configuration possible   in the future."
        }
      }
    }
  },
  "required": [
    "x-request-id",
    "instanceId",
    "upgradeInstanceBody"
  ]
}

retrieveInstancesActionsAuditsList

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

Parameters10

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
instanceId	integer	optional
requestId	string	optional
changedBy	string	optional
startDate	string	optional
endDate	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    },
    "requestId": {
      "type": "string"
    },
    "changedBy": {
      "type": "string"
    },
    "startDate": {
      "type": "string",
      "format": "date"
    },
    "endDate": {
      "type": "string",
      "format": "date"
    }
  },
  "required": [
    "x-request-id"
  ]
}

retrieveInstancesAuditsList

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

Parameters10

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
instanceId	integer	optional
requestId	string	optional
changedBy	string	optional
startDate	string	optional
endDate	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    },
    "requestId": {
      "type": "string"
    },
    "changedBy": {
      "type": "string"
    },
    "startDate": {
      "type": "string",
      "format": "date"
    },
    "endDate": {
      "type": "string",
      "format": "date"
    }
  },
  "required": [
    "x-request-id"
  ]
}

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.

Parameters8

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
name	string	optional
standardImage	boolean	optional
search	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "name": {
      "type": "string"
    },
    "standardImage": {
      "type": "boolean"
    },
    "search": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id"
  ]
}

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.

Parameters3

x-request-id	string	required
x-trace-id	string	optional
createCustomImageBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "createCustomImageBody": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Image Name"
        },
        "description": {
          "type": "string",
          "description": "Image Description"
        },
        "url": {
          "type": "string",
          "description": "URL from where the image has been downloaded / provided."
        },
        "osType": {
          "type": "string",
          "enum": [
            "Windows",
            "Linux"
          ],
          "description": "Provided type of operating system (OS). Please specify `Windows` for MS Windows and `Linux` for other OS. Specifying wrong OS type may lead to disfunctional cloud instance."
        },
        "version": {
          "type": "string",
          "description": "Version number to distinguish the contents of an image. Could be the version of the operating system for example."
        }
      },
      "required": [
        "name",
        "url",
        "osType",
        "version"
      ]
    }
  },
  "required": [
    "x-request-id",
    "createCustomImageBody"
  ]
}

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
imageId	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "imageId": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "imageId"
  ]
}

updateImage

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

Parameters4

x-request-id	string	required
x-trace-id	string	optional
imageId	string	required
updateImageBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "imageId": {
      "type": "string"
    },
    "updateImageBody": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Image Name"
        },
        "description": {
          "type": "string",
          "description": "Image Description"
        }
      }
    }
  },
  "required": [
    "x-request-id",
    "imageId",
    "updateImageBody"
  ]
}

deleteImage

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
imageId	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "imageId": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "imageId"
  ]
}

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

Parameters2

x-request-id	string	required
x-trace-id	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id"
  ]
}

retrieveSnapshotList

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

Parameters7

x-request-id	string	required
x-trace-id	string	optional
instanceId	integer	required
page	integer	optional
size	integer	optional
orderBy	array	optional
name	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "name": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "instanceId"
  ]
}

createSnapshot

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

Parameters4

x-request-id	string	required
x-trace-id	string	optional
instanceId	integer	required
createSnapshotBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    },
    "createSnapshotBody": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 30,
          "description": "The name of the snapshot. It may contain letters, numbers, spaces, dashes. There is a limit of 30 characters per snapshot."
        },
        "description": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The description of the snapshot. There is a limit of 255 characters per snapshot."
        }
      },
      "required": [
        "name"
      ]
    }
  },
  "required": [
    "x-request-id",
    "instanceId",
    "createSnapshotBody"
  ]
}

retrieveSnapshot

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

Parameters4

x-request-id	string	required
x-trace-id	string	optional
instanceId	integer	required
snapshotId	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    },
    "snapshotId": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "instanceId",
    "snapshotId"
  ]
}

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.

Parameters5

x-request-id	string	required
x-trace-id	string	optional
instanceId	integer	required
snapshotId	string	required
updateSnapshotBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    },
    "snapshotId": {
      "type": "string"
    },
    "updateSnapshotBody": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 30,
          "description": "The name of the snapshot. Tags may contain only letters, numbers, spaces, dashes. There is a limit of 30 characters per snapshot."
        },
        "description": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The description of the snapshot. There is a limit of 255 characters per snapshot."
        }
      }
    }
  },
  "required": [
    "x-request-id",
    "instanceId",
    "snapshotId",
    "updateSnapshotBody"
  ]
}

deleteSnapshot

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

Parameters4

x-request-id	string	required
x-trace-id	string	optional
instanceId	integer	required
snapshotId	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    },
    "snapshotId": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "instanceId",
    "snapshotId"
  ]
}

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

Parameters5

x-request-id	string	required
x-trace-id	string	optional
instanceId	integer	required
snapshotId	string	required
rollbackSnapshotBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    },
    "snapshotId": {
      "type": "string"
    },
    "rollbackSnapshotBody": {
      "type": "object",
      "properties": {}
    }
  },
  "required": [
    "x-request-id",
    "instanceId",
    "snapshotId",
    "rollbackSnapshotBody"
  ]
}

retrieveImageAuditsList1

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

Parameters10

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
imageId	string	optional
requestId	string	optional
changedBy	string	optional
startDate	string	optional
endDate	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "imageId": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "changedBy": {
      "type": "string"
    },
    "startDate": {
      "type": "string",
      "format": "date"
    },
    "endDate": {
      "type": "string",
      "format": "date"
    }
  },
  "required": [
    "x-request-id"
  ]
}

retrieveSnapshotsAuditsList

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

Parameters11

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
instanceId	integer	optional
snapshotId	string	optional
requestId	string	optional
changedBy	string	optional
startDate	string	optional
endDate	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "instanceId": {
      "type": "integer",
      "format": "int64"
    },
    "snapshotId": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "changedBy": {
      "type": "string"
    },
    "startDate": {
      "type": "string",
      "format": "date"
    },
    "endDate": {
      "type": "string",
      "format": "date"
    }
  },
  "required": [
    "x-request-id"
  ]
}

listHandles

List all handles - List and filter all your handles

Parameters12

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
name	string	optional
showDefaults	boolean	optional
search	string	optional
countries	string	optional
handleType	string	optional
firstName	string	optional
lastName	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "name": {
      "type": "string"
    },
    "showDefaults": {
      "type": "boolean"
    },
    "search": {
      "type": "string"
    },
    "countries": {
      "type": "string"
    },
    "handleType": {
      "type": "string"
    },
    "firstName": {
      "type": "string"
    },
    "lastName": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id"
  ]
}

createHandle

Create specific handle - Create specific handle

Parameters3

x-request-id	string	required
x-trace-id	string	optional
createHandleBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "createHandleBody": {
      "type": "object",
      "properties": {
        "handleType": {
          "type": "string",
          "enum": [
            "person",
            "organization"
          ],
          "description": "The type of the handle"
        },
        "firstName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "Handle first name"
        },
        "lastName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "Handle last name"
        },
        "organization": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The organization of the handle"
        },
        "email": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "Handle email"
        },
        "gender": {
          "type": "string",
          "enum": [
            "male",
            "female",
            "na"
          ],
          "description": "Handle gender"
        },
        "birthInfo": {
          "type": "string",
          "description": "The birth info of the handle"
        },
        "address": {
          "type": "string",
          "description": "Address details for handle"
        },
        "phone": {
          "type": "string",
          "description": "Handle phone"
        },
        "fax": {
          "type": "string",
          "description": "Handle fax"
        }
      },
      "required": [
        "handleType",
        "firstName",
        "lastName",
        "email",
        "gender",
        "address",
        "phone"
      ]
    }
  },
  "required": [
    "x-request-id",
    "createHandleBody"
  ]
}

retrieveHandle

Get specific handle - Get specific handle

Parameters3

x-request-id	string	required
x-trace-id	string	optional
handleId	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "handleId": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "handleId"
  ]
}

removeHandle

Remove specific handle - Remove specific handle

Parameters3

x-request-id	string	required
x-trace-id	string	optional
handleId	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "handleId": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "handleId"
  ]
}

updateHandle

Update specific handle - Update specific handle

Parameters4

x-request-id	string	required
x-trace-id	string	optional
handleId	string	required
updateHandleBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "handleId": {
      "type": "string"
    },
    "updateHandleBody": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "Handle email"
        },
        "gender": {
          "type": "string",
          "enum": [
            "male",
            "female",
            "na"
          ],
          "description": "Handle gender"
        },
        "birthInfo": {
          "type": "string",
          "description": "The birth info of the handle"
        },
        "address": {
          "type": "string",
          "description": "Address details for handle"
        },
        "phone": {
          "type": "string",
          "description": "Handle phone"
        },
        "fax": {
          "type": "string",
          "description": "Handle fax"
        }
      },
      "required": [
        "email",
        "gender",
        "address",
        "phone"
      ]
    }
  },
  "required": [
    "x-request-id",
    "handleId",
    "updateHandleBody"
  ]
}

setDefaultHandle

Set default handle - Set default handle

Parameters3

x-request-id	string	required
x-trace-id	string	optional
handleId	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "handleId": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "handleId"
  ]
}

validateDomainAvailability

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
domain	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "domain": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "domain"
  ]
}

listDomains

List all domains - List and filter all your domains

Parameters8

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
sld	string	optional
tld	string	optional
status	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sld": {
      "type": "string"
    },
    "tld": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "ready",
        "processing",
        "transferring in",
        "transferring out",
        "manual_task",
        "transferred"
      ]
    }
  },
  "required": [
    "x-request-id"
  ]
}

orderDomain

Create or transfer a domain - Create or transfer a domain

Parameters3

x-request-id	string	required
x-trace-id	string	optional
orderDomainBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "orderDomainBody": {
      "type": "object",
      "properties": {
        "domain": {
          "type": "string",
          "description": "Domain name"
        },
        "authCode": {
          "type": "string",
          "description": "The domain auth code"
        },
        "handles": {
          "type": "string",
          "description": "The handles of the domain"
        },
        "nameservers": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "hostname": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Nameservers"
              },
              "ipV4": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "IPv4 of nameserver"
              },
              "ipV6": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "IPv6 of nameserver"
              }
            },
            "required": [
              "hostname"
            ]
          },
          "description": "Nameservers"
        },
        "resourceType": {
          "type": "string",
          "enum": [
            "instance",
            "server",
            "package"
          ],
          "description": "The identifier of the resource type"
        },
        "resourceId": {
          "type": "string",
          "description": "The identifier of the resource id"
        }
      },
      "required": [
        "domain",
        "handles",
        "nameservers"
      ]
    }
  },
  "required": [
    "x-request-id",
    "orderDomainBody"
  ]
}

retrieveDomain

List specific domain - List specific domain

Parameters3

x-request-id	string	required
x-trace-id	string	optional
domain	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "domain": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "domain"
  ]
}

updateDomain

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

Parameters4

x-request-id	string	required
x-trace-id	string	optional
domain	string	required
updateDomainBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "domain": {
      "type": "string"
    },
    "updateDomainBody": {
      "type": "object",
      "properties": {
        "nameservers": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "hostname": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Nameservers"
              },
              "ipV4": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "IPv4 of nameserver"
              },
              "ipV6": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "IPv6 of nameserver"
              }
            },
            "required": [
              "hostname"
            ]
          },
          "description": "Nameservers"
        },
        "handles": {
          "type": "string",
          "description": "The handles of the domain"
        }
      }
    }
  },
  "required": [
    "x-request-id",
    "domain",
    "updateDomainBody"
  ]
}

cancelDomain

Cancel a specific domain - Cancel a specific domain

Parameters4

x-request-id	string	required
x-trace-id	string	optional
domain	string	required
cancelDomainBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "domain": {
      "type": "string"
    },
    "cancelDomainBody": {
      "type": "object",
      "properties": {
        "reason": {
          "type": "string",
          "enum": [
            "Technical issues / Outages / Performance",
            "Too expensive / price",
            "Product not needed anymore",
            "Bad customer support",
            "Switch to a different Contabo product",
            "Missing features",
            "Other"
          ],
          "description": "Reason for cancelling an domain"
        },
        "reasonText": {
          "type": "string",
          "description": "Reason Text when `Other` reason got selected while cancelling an domain"
        },
        "cancelDate": {
          "type": "string",
          "format": "date-time",
          "description": "Date of cancellation"
        }
      }
    }
  },
  "required": [
    "x-request-id",
    "domain",
    "cancelDomainBody"
  ]
}

getAuthCode

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
domain	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "domain": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "domain"
  ]
}

revokeCancelDomain

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
domain	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "domain": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "domain"
  ]
}

confirmDomainTransferOut

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
domain	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "domain": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "domain"
  ]
}

revokeDomainTransferOut

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
domain	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "domain": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "domain"
  ]
}

retrieveHandlesAuditsList

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

Parameters10

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
handleId	string	optional
requestId	string	optional
changedBy	string	optional
startDate	string	optional
endDate	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "handleId": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "changedBy": {
      "type": "string"
    },
    "startDate": {
      "type": "string",
      "format": "date"
    },
    "endDate": {
      "type": "string",
      "format": "date"
    }
  },
  "required": [
    "x-request-id"
  ]
}

retrieveDomainsAuditsList

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

Parameters10

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
domain	string	optional
requestId	string	optional
changedBy	string	optional
startDate	string	optional
endDate	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "domain": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "changedBy": {
      "type": "string"
    },
    "startDate": {
      "type": "string",
      "format": "date"
    },
    "endDate": {
      "type": "string",
      "format": "date"
    }
  },
  "required": [
    "x-request-id"
  ]
}

retrieveObjectStorageList

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

Parameters9

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
dataCenterName	string	optional
s3TenantId	string	optional
region	string	optional
displayName	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "dataCenterName": {
      "type": "string",
      "minLength": 1
    },
    "s3TenantId": {
      "type": "string"
    },
    "region": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id"
  ]
}

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`

Parameters3

x-request-id	string	required
x-trace-id	string	optional
createObjectStorageBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "createObjectStorageBody": {
      "type": "object",
      "properties": {
        "region": {
          "type": "string",
          "minLength": 1,
          "description": "Region where the object storage should be located. Default is EU. Available regions: EU, US-central, SIN"
        },
        "autoScaling": {
          "type": "string",
          "description": "Autoscaling settings"
        },
        "totalPurchasedSpaceTB": {
          "type": "number",
          "format": "double",
          "description": "Amount of purchased / requested object storage in TB."
        },
        "displayName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "Display name helps to differentiate between object storages, especially if they are in the same region. If display name is not provided, it will be generated. Display name can be changed any time."
        }
      },
      "required": [
        "region",
        "totalPurchasedSpaceTB"
      ]
    }
  },
  "required": [
    "x-request-id",
    "createObjectStorageBody"
  ]
}

retrieveDataCenterList

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

Parameters9

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
slug	string	optional
name	string	optional
regionName	string	optional
regionSlug	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "slug": {
      "type": "string",
      "minLength": 1
    },
    "name": {
      "type": "string",
      "minLength": 1
    },
    "regionName": {
      "type": "string",
      "minLength": 1
    },
    "regionSlug": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "x-request-id"
  ]
}

retrieveObjectStorage

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

Parameters3

x-request-id	string	required
x-trace-id	string	optional
objectStorageId	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "objectStorageId": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "objectStorageId"
  ]
}

updateObjectStorage

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

Parameters4

x-request-id	string	required
x-trace-id	string	optional
objectStorageId	string	required
updateObjectStorageBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "objectStorageId": {
      "type": "string"
    },
    "updateObjectStorageBody": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "Display name helps to differentiate between object storages, especially if they are in the same region."
        }
      },
      "required": [
        "displayName"
      ]
    }
  },
  "required": [
    "x-request-id",
    "objectStorageId",
    "updateObjectStorageBody"
  ]
}

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.

Parameters4

x-request-id	string	required
x-trace-id	string	optional
objectStorageId	string	required
upgradeObjectStorageBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "objectStorageId": {
      "type": "string"
    },
    "upgradeObjectStorageBody": {
      "type": "object",
      "properties": {
        "autoScaling": {
          "type": "string",
          "description": "New monthly object storage size limit for autoscaling if enabled."
        },
        "totalPurchasedSpaceTB": {
          "type": "number",
          "format": "double",
          "description": "New total object storage limit. If this number is larger than before you will also be billed for the added storage space. No downgrade possible."
        }
      }
    }
  },
  "required": [
    "x-request-id",
    "objectStorageId",
    "upgradeObjectStorageBody"
  ]
}

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.

Parameters3

x-request-id	string	required
x-trace-id	string	optional
objectStorageId	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "objectStorageId": {
      "type": "string"
    }
  },
  "required": [
    "x-request-id",
    "objectStorageId"
  ]
}

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.

Parameters4

x-request-id	string	required
x-trace-id	string	optional
objectStorageId	string	required
CancelObjectStorageBody	object	required

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "objectStorageId": {
      "type": "string"
    },
    "CancelObjectStorageBody": {
      "type": "object",
      "properties": {
        "cancelDate": {
          "type": "string",
          "format": "date-time",
          "description": "Date of cancellation"
        }
      }
    }
  },
  "required": [
    "x-request-id",
    "objectStorageId",
    "CancelObjectStorageBody"
  ]
}

retrieveObjectStorageAuditsList

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

Parameters10

x-request-id	string	required
x-trace-id	string	optional
page	integer	optional
size	integer	optional
orderBy	array	optional
objectStorageId	string	optional
requestId	string	optional
changedBy	string	optional
startDate	string	optional
endDate	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "x-request-id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-5][0-9A-Fa-f]{3}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "x-trace-id": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int64"
    },
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "objectStorageId": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "changedBy": {
      "type": "string"
    },
    "startDate": {
      "type": "string",
      "format": "date"
    },
    "endDate": {
      "type": "string",
      "format": "date"
    }
  },
  "required": [
    "x-request-id"
  ]
}

README.md6 KBView on GitHub

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.
Deterministic orchestration: OrcA plans and executes multi-tool tasks predictably—no brittle prompt chaining.
Vendor-neutral: Works with any MCP client: ChatGPT, Claude, QBot, chatMCP. OAS + MCP + Arazzo stay portable.

How It Works

Pick your API spec
- OpenAPI, Swagger, REST—HAPI CLI works with any API specification format.
- Supports OpenAPI 3.0+, REST APIs, OAuth 2.0 Dynamic Client Registration.
Run a single command
- One simple CLI command transforms your API into a usable MCP Server.
- No complex setup, zero configuration, works anywhere, cross-platform.
Use instantly
- Your API is now ready as a tool, AI agent, or testing interface.
- MCP server ready, AI agent compatible, testing interface, developer experience friendly.

Visual Pipeline

code

API Spec (swagger.json) → HAPI CLI → Usable Tool (AI-ready) ← MCP Clients

code

[ OpenAPI / Swagger ]       [ HAPI CLI ]        [ MCP Server ]
       (Your API)         →   (Transform)   →   (Usable Tool)
                                                 ↑          ↑
                                                 |          |
                                          [ ChatGPT ]  [ runMCP ]
                                          [ Claude  ]  [ OrcA   ]
                                          [ QBot    ]  [ chatMCP]
                                          [ Agents  ]

Who Wins With HAPI

Executives: Ship AI initiatives without ballooning cost. Keep teams focused on outcomes, not rewrites and integration sprawl.
Architects & PMs: Design with OpenAPI/Arazzo, run with MCP. Clear contracts, policy inheritance, and versioned workflows keep risk low.
Engineers & Ops: Deploy once. HAPI Server + runMCP scale tools; QBot/chatMCP give fast feedback; OrcA keeps executions deterministic.

Your Stack, Already Wired

HAPI Server: Turns OpenAPI into MCP tools automatically—contracts stay in sync with your source of truth.
runMCP: Autoscaling execution and testing for MCP tools; cold-start fast, stay warm when workflows run long.
QBot: CLI TUI for power users to interact with MCP tools directly from terminal or scripts.
chatMCP: Conversational client that speaks MCP natively for support, ops, and internal assistants.
OrcA: Deterministic planning and orchestration for multi-tool tasks; no brittle prompt spaghetti.
Agents: Build agentic systems from standard APIs—no custom glue. Connect MCP clients across platforms.

Demos

Playlist with demos
New HAPI MCP YT Channel with demos API-First and MCP

Documentation

FAQ

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.

Get Started

Install HAPI CLI from latest release: https://github.com/la-rebelion/hapimcp/releases
Transform your OpenAPI spec into an MCP server with a single command:
bash
```
hapi serve path/to/your/swagger.json --headless
```
Start using your MCP tools with any compatible client!
Explore the documentation for advanced usage and best practices.

Contributing

Contributions are welcome! Open a discussion or submit a pull request on GitHub: https://github.com/la-rebelion/hapimcp

License

HAPI MCP is licensed under the MIT License. See LICENSE for details.

Install

Tools (124)

tool_searchretrieveTagListcreateTagretrieveTagupdateTagdeleteTagretrieveAssignmentListretrieveAssignment

Remote endpoint

Streamable HTTP

Hosted server - connect over the network, no local install.

url

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

Add to VS Code Add to Cursor

claude_desktop_config.json

json

{
  "mcpServers": {
    "contabo": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://contabo.run.mcp.com.ai/mcp"
      ]
    }
  }
}

Desktop config is stdio-only; this bridges via mcp-remote. Native remote: Settings > Connectors.