1.0 API

Warning
 The Documentation is as the API itself highly experimental. Use with care. And do not vaporize your local super cluster.

1.1 Overview

1.1.1 Introduction

The CAP API operates over HTTPS and uses JSON as its data format. The API is a RESTful API and utilizes HTTP methods and HTTP status codes to specify requests and responses.

1.1.2 Getting Started

WIP

1.1.3 Authentication

WIP

1.1.4 Errors

WIP

1.1.5 Rate Limiting

WIP

1.1 Users

1.1.1 Get all users

Returns all existing User objects

HTTP Request
GET /users

Query Parameters

name: string
Can be used to filter resources by their name. The response will only contain the resources matching the specified name

1.1.2 Create a user

Creates a new User. Returns preliminary information about the Server as well as an Action that covers progress of creation.

HTTP Request
POST /users

1.1.3 Delete a user

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

1.1.4 Get a user

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

1.1.5 Update a user

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

2.0 Sample CAP Data Types

Customer

  • id: Integer

  • customerNumber: String

  • userName: String

  • passwordHash: String

  • emailAdress: String

  • customerAddresses: Object

  • bankAccounts: Object

  • orderProcessingContract: Boolean

  • bookedContracts: Object

  • billingState: Object

Account

  • id: Integer

  • userName: String

  • passwordHash: String

  • customerNumber: String

Domain

  • id: Integer

  • domainName: String

  • tempDomainName: String

  • Type: Integer

  • path: String

  • sslState: Array

  • phpVersion: String

  • isActive: Boolean

  • DKIMSign: Boolean

  • accountId: Integer

  • customerNumber: String

Email

  • id: Integer

  • domainName: String

  • accountName: String

  • mailboxSize: Integer

  • accountId: Integer

  • customerNumber: String

EmailRedirect

  • id: Integer

  • domainName: String

  • accountName: String

  • target: String

  • accountId: Integer

  • customerNumber: String

FTPUser

  • id: Integer

  • userName: String

  • passwordHash: String

  • path: String

  • domainName: String

  • permissions: String

  • virusScan: Boolean

  • accountId: Integer

  • customerNumber: String

DatabaseUser

  • id: Integer

  • userName: String

  • hostName: String

  • accountId: Integer

  • customerNumber: String

Database

  • id: Integer

  • type: string

  • databaseName: String

  • databaseUsers: String

  • accountId: Integer

  • size: Integer // Needs manually checking. Stupid mysql.