/login

post

Log in

/logout

get

Log out

/registerInvitation

post

Register invitation (deprecated)

post

Register invitation - create a user and a first contact

/resetting

post

Reset password request

post

Confirm reset password

/organisations

post

Create a new organisation

get

List of all available organisations

put

Update an organisation

patch

Update an organisation's field

delete

Delete a organisation

get

Get an organisation

get

Get list of suborganisations

post

Create a new invitation

get

List of all available invitations

put

Update a invitation

delete

Delete a invitation

get

Get a invitation

get

Check if an invitation is still available

post

Create cp3 user on cp4 (action only for admin)

get

List of all available users

patch

Update part of the user

delete

Delete a user

get

Get a user

post

Change user password

post

Disable or enable a user

post

Create a new contact

get

List of all available contacts

put

Update a contact

delete

Delete a contact

get

Get a contact

post

Create a new sshkey

get

List of all available sshkeys

put

Update a sshkey

delete

Delete a sshkey

get

Get a sshkey

post

Create a new contact

get

List of all available contacts

put

Update a contact

delete

Delete a contact

get

Get a contact

post

Create a new user and their first contact (admin only)

patch

Update a cp3 user

post

Add access to an organisation

delete

Remove access to an organisation

get

Get all entities for organisation which user has access for

get

Get a lit of all entities (csv)

get

Get all organisation notifications

post

Send a notification for an organisation (currently no available organisation notifications exist)

get

Get crm notifications for an organisation

post

Create a new sshkey

get

List of all available sshkeys

put

Update a sshkey

delete

Delete a sshkey

get

Get a sshkey

get

Get all organisation's sshkeys (user and deploy sshkeys) (admin only)

post

Create a new team

get

Get list of all available teams

put

Update a team

delete

Delete a team

get

Get a team

post

Add a user to the team

get

List of all available users

get

Get a user in a team

delete

Remove the user from the team

patch

Update autoAddSshkey parameter

get

Get users who don't belong to a team

get

Get all entities for an organisation which can be added to a team

get

Get all entities which can be added to a team (admin only)

post

Add an app to the team

get

List of all available apps

get

Get the app for the team

delete

Remove the app from the team

post

Add a domain to the team

get

List of all available domains

get

Get the domain for the team

delete

Remove the domain from the team

post

Add a mailgroup to the team

get

List of all available mailgroups

get

Get the mailgroup for the team

delete

Remove the mailgroup from the team

post

Add a system to the team

get

List of all available systems

get

Get the system for the team

delete

Remove the system from the team

get

Get billableitemInfo data

get

Get available pricegroups for an organisation

get

Get available genericItem products for an organisation

post

Create a new project

get

List of all available projects

put

Update a project

delete

Delete a project

get

Get a project

post

Add an app to a project

get

Get apps for a project

delete

Remove an app from a project

get

Get an app for a project

post

Add a domain to a project

get

Get domains for a project

delete

Remove a domain from a project

get

Get a domain for a project

post

Add a mailgroup to a project

get

Get mailgroups for a project

delete

Remove a mailgroup from a project

get

Get a mailgroup for a project

post

Add a system to a project

get

Get systems for a project

delete

Remove a system from a project

get

Get a system for a project

post

Add a systemgroup to a project

get

Get systemgroups for a project

delete

Remove a systemgroup from a project

get

Get a systemgroup for a project

get

Get all entities which belongs to a project

get

Get all entities which can be added to a project

get

Get count of an organisation's entities

get

Get total price to pay

get

Download a finance overview in pdf (admin only)

post

Create a new agreement

get

List of all available agreements

delete

Delete a agreement

get

Get a agreement

get

Get a list of agreement's billableitems

get

Get a list of agreement's attachments

/organisationandinvitation

post

Create an organisation and a first invitation

/invitations

post

Send a notification for an invitation

/users

post

Send a notification for an user

/contacts

get

List of all accessible contacts

/apps

post

Create a new app

get

List of all available apps

put

Update an app

delete

Delete a app

get

Get a app

get

Get users for an app

get

Get organisations with acl access to an app

post

Deactivate or activate an app

post

Create a new component

get

List of all available components

put

Update a component

delete

Delete a component

get

Get a component

post

Execute an action for an appcomponent

post

Create a new url

get

List of all available urls

put

Update a url

delete

Delete a url

get

Get a url

get

Get available backups for an appcomponent

get

Get all sshkeys which can be added to a component for a logged in user

post

Create a new sslcertificate

get

List of all available sslcertificates

put

Update sslCertificate

delete

Delete a sslcertificate

get

Get a sslcertificate

post

Create a job for an SslCertificate

post

Fix an invalid certificate

get

Return a private key for type own sslCertificate

get

Get all urls for an app

get

Get all matching sslCertificates for the url

post

Create a new migration

get

List of all available migrations

put

Update an migration

get

Get a migration

post

Execute an action for a migration

post

Create a new restore

get

List of all available restores

put

Update a restore

delete

Delete a restore

get

Get a restore

get

Get a restore file

post

Add access to an app

delete

Remove access to an app

get

Get notifications for an app

post

Send a notification for an app (currently no available app notifications exist)

post

Create a billableitem (action only for admin)

get

Get billableitem for an existing app

patch

Update an existing billableitem

delete

Delete a billableitem (action only for admin)

post

Add an agreement to billableitem (action only for admin)

delete

Delete an agreement from billableitem (action only for admin)

patch

Update an existing billableitem detail

patch

Update externalInfo for an existing billableitem

post

Create integrity check for app

get

Get app integrity checks

get

Get app integrity check

get

Get app integrity check

get

Calculate price for a new component

get

Calculate price for a new component for a reseller organisation

get

Returns all prices for appcomponents

get

Calculate price for a new sslCertificate

get

Calculate price for a new sslCertificate for a reseller organisation

get

Returns all prices for sslCertificates

/appcomponenttypes

get

List of all available component types

/appcomponents

get

Get appcomponents for a chosen category

post

Send a notification for an appcomponent

/urls

get

Get all urls

post

Send a notification for an url

/sslcertificates

get

Get sslCertificates from all apps

/systemsandgroups

get

Get available systems and groups

get

Get available systems and groups for component type

/domains

post

Create a new domain

get

List of all available domains

put

Update a domain

patch

Update a domain

delete

Delete a domain

get

Get a domain

get

Get users for domain

get

Get organisations with acl access to a domain

post

Execute an action on a domain (admin only)

put

Transfer a domain

put

Internal transfer (available only for dnsbe domains)

put

Create a domain at domain provider for existing in db domain

get

Get outgoing transfer code

post

Create a new record

get

List of all available records

put

Update a record

delete

Delete a record

get

Get a record

post

Delete an old record and create a new one

post

Add access to a domain

delete

Remove access to a domain

get

Get notifications for a domain

post

Send a notification for a domain

post

Create a billableitem (action only for admin)

get

Get price for an existing domain

patch

Update an existing billableitem

delete

Delete a billableitem (action only for admin)

post

Add an agreement to billableitem (action only for admin)

delete

Delete an agreement from billableitem (action only for admin)

patch

Update an existing billableitem detail

patch

Update externalInfo for an existing billableitem

get

List of all sslCertificates for the domain

delete

Delete an sslCertificate

post

Create a job for sslCertificate

post

Create integrity check for domain

get

Get domain integrity checks

get

Get domain integrity check

get

Get domain integrity check

get

Calculate price for a new domain

get

Calculate price for a new domain for a reseller organisation

get

Returns prices for all domain extensions

get

Get domain providers

get

Request domain transfer code

get

Check availability of a domain

/domaincontacts

post

Create a new domaincontact

get

List of all available domaincontacts

put

Update a domaincontact

delete

Delete a domaincontact

get

Get a domaincontact

post

Add access to a domaincontact

delete

Remove access to a domaincontact

/documents

post

Create a new document (action only for admin)

get

List of all available documents

put

Update document (action only for admin)

get

Get a document

post

Mark a document as paid (action only for admin)

post

Process a credit note (action only for admin)

post

Credit a Document = create a creditnote with identical but negative documentitems (action only for admin)

post

Credit a Document's items = create a creditnote with identical but negative documentitems (action only for admin)

get

Get users for document

post

Create a new item (action only for admin)

get

List of all available items

put

Update an item (action only for admin)

delete

Delete an item (action only for admin)

get

Get a item

post

Add access to a document

delete

Remove access to a document

get

Get notifications for a document

post

Send a notification for a document

get

Get a single document (a user is not logged in)

post

Pay online

post

Pay online (a user is not logged in)

post

Complete online payment

post

Complete online payment

post

Starting online payment by bancontact

post

Starting online payment by bancontact

post

Pay online (bancontact)

post

Pay online (bancontact)

post

Match a document with a payment (action only for admin)

get

Get total price to pay

/documentitems

get

Get all accessible documentitems

/billableitems

get

Get documents for a billableitem

/billableitemdetails

get

Get a list of all accessible billableitemDetails which were not billed yet

/downloadpdf

get

Download a document in pdf (a user is logged in)

get

Download a document in pdf (a user is not logged in)

/payments

post

Create a new payment (action only for admin)

get

List of all available payments

put

Update a new payment (action only for admin)

patch

Update a new payment (action only for admin)

delete

Delete a new payment (action only for admin)

get

Get a payment

/genericitems

post

Create a new genericitem

get

List of all available genericitems

put

Update a genericitem

delete

Delete a genericitem

get

Get a genericitem

get

Get users for genericitem

post

Deactivate or activate a genericitem

post

Add access to a genericitem

delete

Remove access to a genericitem

get

Get notifications for a genericitem

post

Send a notification for a genericitem (currently no available genericItem notifications exist)

post

Create a billableitem (action only for admin)

get

Get price for an existing genericItem

patch

Update an existing billableitem

delete

Delete a billableitem (action only for admin)

post

Add an agreement to billableitem (action only for admin)

delete

Delete an agreement from billableitem (action only for admin)

patch

Update an existing billableitem detail

patch

Update externalInfo for an existing billableitem

get

Calculate price for a new genericItem

get

Calculate price for a new genericItem for a reseller organisation

get

Returns prices for all genericItem products

/genericitem

get

Get available GenericItem products

/mailgroups

post

Create a new mailgroup

get

List of all available mailgroups

put

Update a mailgroup

delete

Delete a mailgroup

get

Get a mailgroup

get

Get users for mailgroup

get

Get organisations with acl access to a mailgroup

post

Deactivate or activate a mailgroup

post

Link a domain to a mailgroup. Attention! This sets the domain’s MX servers to point to the right direction. Existing MX records will be overwritten

delete

Unlink a domain from the mailgroup

patch

Update handleMailDns on domain (admin only)

patch

Set primary domain

post

Create a new mailbox

get

List of all available mailboxes

put

Update a mailbox

delete

Delete a mailbox

get

Get a mailbox

post

Create a new address

get

List of all available addresses

delete

Delete a address

put

Update an address

get

Get a address

post

Create a new mailforwarder

get

List of all available mailforwarders

put

Update a mailforwarder

delete

Delete a mailforwarder

get

Get a mailforwarder

post

Add access to a mailgroup

delete

Remove access to a mailgroup

get

Get notifications for a mailgroup

post

Send a notification for a mailgroup (currently no available mailgroup notifications exist)

post

Create a billableitem (action only for admin)

get

Get price for an existing mailgroup

patch

Update an existing billableitem

delete

Delete a billableitem (action only for admin)

post

Add an agreement to billableitem (action only for admin)

delete

Delete an agreement from billableitem (action only for admin)

patch

Update an existing billableitem detail

patch

Update externalInfo for an existing billableitem

post

Create integrity check for mailgroup

get

Get mailgroup integrity checks

get

Get mailgroup integrity check

get

Get mailgroup integrity check

get

Calculate price for a new mailgroup

get

Calculate price for a new mailgroup for a reseller organisation

get

Get all prices for mailboxes

/mailboxes

post

Send a notification for an mailbox

/mailboxandaddresses

post

Create Mailbox and addresses (and Mailgroup if needed)

/mailboxaddresses

post

Send a notification for an mailbox address

/mailbox/password

post

Updates mailbox password (without cp4 authorization)

/mailforwarders

post

Create a mailforwarder (and Mailgroup if needed)

/systems

post

Create a new system

get

List of all available systems

put

Update a system

delete

Delete a system

get

Get a system

delete

Force a system deletion (admin only)

post

Create a new cookbook

get

List of all available cookbooks

put

Update a cookbook

delete

Delete a cookbook

get

Get a cookbook

post

Create a new check

get

List of all available checks

put

Update a check

delete

Delete a check

get

Get a check

get

Get all checkalerts for the check

get

Get all checkalerts for the system

get

Get users for system

get

Get organisations with acl access to a system

get

Get all sshkeys which can be added to a system for a logged in user

post

Start/shutdown/stop/reboot/enable_monitoring/disable_monitoring/deactivate/activate a system

get

Get system cpu data

get

Get system memory data

get

Get system disk data

get

Get system memory data

post

Link a system with an sshkey

get

Get a system's sshkeys

delete

Unlink an sshkey from a system

get

Get a system's sshkey

get

Get s system to import

post

A system is ready to execute cp4jobs and has started its queue worker

post

Add access to a system

delete

Remove access to a system

get

Get notifications for a system

post

Send a notification for a system

post

Create a billableitem (action only for admin)

get

Get price for an existing system

patch

Update an existing billableitem

delete

Delete a billableitem (action only for admin)

post

Add an agreement to billableitem (action only for admin)

delete

Delete an agreement from billableitem (action only for admin)

patch

Update an existing billableitem detail

patch

Update externalInfo for an existing billableitem

patch

Update runningStatus of cp3 imported system (admin only)

post

Link a system with a systemgroup

get

Get a system's groups

delete

Unlink an system from a systemgroup

get

Get a system's systemgroup

delete

Force a system deletion from a systemgroup (admin only)

post

Create a new systemHasNetwork with SystemHasNetworkIps (admin only)

get

Get systemHasNetworks (admin only)

post

Converts a new systemHasNetwork to cp4 from cp3 (admin only)

get

Get a systemHasNetwork (admin only)

delete

Delete a systemHasNetwork (admin only)

put

Converts a new systemHasNetwork to cp4 from cp3 (admin only)

delete

Delete a cp3 systemHasNetwork (admin only)

post

Creates a systemHasNetworkIp with a new ip/ips (admin only)

get

Get systemHasNetworkIps (admin only)

post

Converts a new systemHasNetworkIp to cp4 from cp3 (admin only)

get

Get a systemHasNetworkIp (admin only)

delete

Delete a systemHasNetworkIp (admin only)

put

Converts a new systemHasNetworkIp to cp4 from cp3 (admin only)

delete

Delete a cp3 systemHasNetworkIp (admin only)

post

Create integrity check for system

get

Get system integrity checks

get

Get system integrity check

get

Get system integrity check

get

Get calculations for a system

post

Calculate price for a new system

post

Calculate price for a new system for a reseller organisation

get

Returns prices for all system providers

get

Get available system providers

get

Get available system provider configurations

get

Get available regions

get

Get available operating systems

post

Find system configurations

post

Create a new system in db

get

Get available security updates dates

/systemimages

get

List of all available values of cookbook's paramater for a Systemimage

/operatingsystemversions

get

List of all available values of cookbook's paramater for a OperatingsystemVersion

/cookbooktypes

get

List of all available cookbook types

/cookbooks

post

Send a notification for an cookbook

/checktypes

get

List of all available check types

/checks

get

All checks of all the systems a user has access on

get

Get a check

/checkalerts

get

Get all checkalerts for all systems

post

Send a notification for an checkalert

/systemgroups

post

Create a new systemgroup

get

List of all available systemgroups

put

Update a systemgroup

delete

Delete a systemgroup

get

Get a systemgroup

post

Add access to a systemgroup

delete

Remove access to a systemgroup

/volumegroups

post

Create a new volumegroup (action only for admin)

get

List of all available volumegroups (action only for admin)

put

Update a volumegroup (not supported in current version)

delete

Delete a volumegroup (action only for admin)

get

Get a volumegroup (action only for admin)

/volumes

post

Create a new volume

get

List of all available volumes

put

Update a volume

delete

Delete a volume

get

Get a volume

post

Add access to a volume

delete

Remove access to a volume

/networks

post

Create a new network (action only for admin)

get

Get list of all available networks

put

Update a network (action only for admin)

delete

Delete a network (action only for admin)

get

Get a network

get

List of network's systems (action only for admin)

post

Fetch an ip from nipap (action only for admin)

delete

Remove an ip from nipap (action only for admin)

/entities

get

Get all entities (admin only)

/order

post

Create entities using one request

/attachments

post

Create a new attachment

get

List of all available attachments

put

Update an attachment

delete

Delete a attachment

get

Get a attachment

get

Download an attachment

/languages

get

List of all available languages

/jobs

get

Get job history (action only for admin)

get

Get job history (action only for admin)

delete

Removes a job (action only for admin)

get

Retry all failed jobs in a job tree (action only for admin)

get

Get root job for a job (action only for admin)