### Fetch Software Installation Details via cURL

Source: https://developer.mittwald.de/docs/v1/reference/software/getSoftwareInstallation

This example demonstrates how to make a GET request to the Mittwald API to retrieve details about a software installation. It requires an authorization token and specifies the target API endpoint.

```curl
$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/installations/string
```

--------------------------------

### Get Software Installation Details (API v1)

Source: https://developer.mittwald.de/docs/v1/reference/software/getSoftwareInstallation

Retrieves detailed information for a specific software installation using its unique identifier. This API endpoint is part of the v1 reference, which is maintained but not actively developed.

```APIDOC
GET /installations/{installationIdentifier}/

API version: v1
Request method: GET
Operation ID: getSoftwareInstallation

Description:
  Diese Operation liest Details zu einer ganz bestimmten Softwareinstallation aus (This operation reads details about a very specific software installation).

Request:
  Path parameters required:
    - installationIdentifier (string, required): ID einer Software-Installation (ID of a software installation).

Responses:
  200 OK:
    Format: application/json
    Description: Details der angegebenen Software-Installation (Details of the specified software installation).
    Schema documentation:
      $ref: "#/components/schemas/SoftwareInstallation"
    Example:
      Content-Type: application/json
      null
```

--------------------------------

### List Software Installations by Account (cURL)

Source: https://developer.mittwald.de/docs/v1/reference/software/listSoftwareInstallationsByAccount

This snippet shows how to fetch a list of software installations for a specific account using cURL. It requires an API token for authentication and specifies the account ID and an optional install path.

```curl
$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/accounts/string/installations?installPath=string
```

--------------------------------

### List Software Installations by Account (API)

Source: https://developer.mittwald.de/docs/v1/reference/accounts/listSoftwareInstallationsByAccount

Retrieves a list of software installations for a specific account. Requires authentication via a bearer token. The `installPath` parameter can be used to filter installations.

```APIDOC
GET /v1/accounts/{accountId}/installations

---

**Description:**
Retrieves a list of software installations for a given account.

**Parameters:**
- `accountId` (path parameter, string): The unique identifier for the account.
- `installPath` (query parameter, string, optional): Filters installations by their installation path.

**Headers:**
- `Authorization`: Bearer <your_api_token>

**Example Usage (cURL):**
```bash
curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/accounts/string/installations?installPath=string
```

**Responses:**
- `200 OK`: Returns a list of software installations.
- `401 Unauthorized`: If the API token is invalid or missing.
- `404 Not Found`: If the account ID does not exist.

**Related Endpoints:**
- List Directories by Account
- Update PHP Version
```

--------------------------------

### Mittwald API v1 Accounts Installations Endpoint

Source: https://developer.mittwald.de/docs/v1/reference/software/listSoftwareInstallationsByAccount

Documentation for the Mittwald API v1 endpoint to list software installations by account. This endpoint allows filtering by install path and requires bearer token authentication.

```APIDOC
GET /v1/accounts/{accountId}/installations

Description:
  Retrieves a list of software installations for a given account.

Parameters:
  - Path Parameters:
    - accountId (string, required): The unique identifier of the account.
  - Query Parameters:
    - installPath (string, optional): Filters installations by their installation path.

Headers:
  - Authorization (string, required): Bearer token for authentication. Example: "Bearer YOUR_API_TOKEN"

Responses:
  - 200 OK: Successfully retrieved the list of installations.
  - 401 Unauthorized: Authentication failed.
  - 404 Not Found: Account not found.
  - 500 Internal Server Error: An unexpected error occurred.

Example Request:
  curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/accounts/string/installations?installPath=string
```

--------------------------------

### cURL Example for Partner Program Order

Source: https://developer.mittwald.de/docs/v1/reference/bestellungen/orderPartnerProgram

Demonstrates how to order a partner program using a cURL command. It includes setting the HTTP method to POST, providing a JSON payload for customer and billing information, and setting necessary headers for authorization and content type.

```curl
$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"customer":{"firstName":"string","lastName":"string","title":"string","salutation":"Herr","street":"string","houseNumber":"string","city":"string","company":"string","emailAddress":"email@mittwald.example","phone":"string","country":"string"},"billing":{"vatRegNumber":"string"}}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v1/orders/partnerprogram

```

--------------------------------

### cURL Example for Get Promotion Code

Source: https://developer.mittwald.de/docs/v1/reference/promotioncode/getPromotionCode

Example usage of the 'Get Promotion Code' API endpoint using cURL. This command demonstrates how to authenticate with a bearer token and specify the promotion code in the request URL.

```bash
$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/promotioncodes/string
```

--------------------------------

### List Software Installation Extensions using cURL

Source: https://developer.mittwald.de/docs/v1/reference/software/listSoftwareInstallationExtensions

This snippet demonstrates how to retrieve a list of extensions for a specific software installation using the cURL command-line tool. It requires an API token for authentication and targets the Mittwald API v1.

```bash
$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/installations/string/extensions
```

--------------------------------

### cURL Usage Example

Source: https://developer.mittwald.de/docs/v1/reference/dsgvoverträge/getGDPRContractPresets

Example of how to call the Get GDPR Contract Presets API endpoint using cURL, including authorization header.

```bash
$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/gdpr/contract-presets
```

--------------------------------

### Get Current Customer cURL Example

Source: https://developer.mittwald.de/docs/v1/reference/kunden/getCurrentCustomer

Example cURL command to fetch the current customer details from the API. Requires an Authorization header with a bearer token.

```curl
$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/customer
```

--------------------------------

### Mittwald API v1 Introduction

Source: https://developer.mittwald.de/docs/v1/reference/dsgvovertr%C3%A4ge

Provides an overview of the Mittwald Developer Portal API v1, stating its maintenance status and recommending API v2 for current development.

```APIDOC
API Version: v1
Status: Maintained, not actively developed.
Recommendation: Use API v2 for up-to-date documentation and features.
```

--------------------------------

### cURL Usage Example

Source: https://developer.mittwald.de/docs/v1/reference/dsgvovertr%C3%A4ge/getGDPRContractPresets

Example of how to call the Get GDPR Contract Presets API endpoint using cURL, including authorization header.

```bash
$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/gdpr/contract-presets
```

--------------------------------

### Mittwald API v1: List Software Installation Extensions Endpoint

Source: https://developer.mittwald.de/docs/v1/reference/software/listSoftwareInstallationExtensions

This API endpoint allows you to fetch all available extensions for a given software installation. It requires an authorization header with a valid bearer token. The response typically includes details about each extension.

```APIDOC
GET /v1/installations/{installationId}/extensions

Description:
  Retrieves a list of extensions for a specific software installation.

Authentication:
  Requires an 'Authorization: Bearer <YOUR_API_TOKEN>' header.

Parameters:
  - installationId (string, path parameter): The unique identifier of the software installation.

Responses:
  - 200 OK: Returns a JSON array of extension objects.
  - 401 Unauthorized: If the API token is missing or invalid.
  - 404 Not Found: If the specified installationId does not exist.

Example Request:
  curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/installations/string/extensions
```

--------------------------------

### Get GDPR PDF API Endpoint

Source: https://developer.mittwald.de/docs/v1/reference/dsgvoverträge/getGDPRPDF

Provides details for the GET request to retrieve a specific GDPR PDF. Includes cURL example, response codes, and associated schemas.

```APIDOC
GET /v1/gdpr/pdfs/{id}

Description:
  Retrieves details for a specific GDPR PDF.

Responses:
  200 OK:
    Description: Das gewünschte Vertrags-PDF
    Content:
      application/json:
        Schema: GDPRPDF (see Get GDPR PDF Response Schema)
  403 Forbidden:
    Description: Authentication or authorization error.

Usage Examples:
  cURL:
    $ curl \
        --fail \
        --location \
        -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
        https://api.mittwald.de/v1/gdpr/pdfs/string
```

--------------------------------

### cURL Example for Creating Subdomain

Source: https://developer.mittwald.de/docs/v1/reference/domains/createSubdomain

Demonstrates how to use cURL to send a POST request to create a subdomain, including authentication and content type headers.

```bash
$ curl \
    --fail \
    --location \
    -X POST \
    -d '[{"name":"string","target":"string"}]' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v1/accounts/string/domains/string/subdomains
```

--------------------------------

### Get Benefit Details API Endpoint

Source: https://developer.mittwald.de/docs/v1/reference/kunden/getBenefitDetails

This section describes the GET request to retrieve specific benefit details for a customer. It includes path parameters, response structure, and a cURL example.

```APIDOC
GET /v1/customers/{customerNumber}/benefits/{benefit}

Path Parameters:
  - customerNumber (integer, required): The customer's unique identification number.
  - benefit (string, required): The identifier for the specific benefit to retrieve.

Responses:
  - 200 OK:
    Description: Successfully retrieved benefit details.
    Content Type: application/json
    Schema:
      type: object
      properties:
        benefit:
          type: object
          properties:
            identifier: { type: string }
            uid: { type: integer }
        exceedance: { type: integer }
        uid: { type: integer }
        usage: { type: integer }
        value: { type: integer }
    Example:
      {
        "benefit": {
          "identifier": "string",
          "uid": 123
        },
        "exceedance": 123,
        "uid": 123,
        "usage": 123,
        "value": 123
      }

Usage Examples:
  - cURL:
    $ curl \
        --fail \
        --location \
        -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
        https://api.mittwald.de/v1/customers/123/benefits/string
```

--------------------------------

### List Guest Operating Systems via cURL

Source: https://developer.mittwald.de/docs/v1/reference/virt/listGuestOperatingSystems

This example demonstrates how to list available guest operating systems using a cURL command. It requires an authorization token for access and targets the Mittwald API endpoint for virtual guest operating systems.

```curl
$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/virt/guestoperatingsystems
```

--------------------------------

### Get GDPR PDF API Endpoint

Source: https://developer.mittwald.de/docs/v1/reference/dsgvovertr%C3%A4ge/getGDPRPDF

Provides details for the GET request to retrieve a specific GDPR PDF. Includes cURL example, response codes, and associated schemas.

```APIDOC
GET /v1/gdpr/pdfs/{id}

Description:
  Retrieves details for a specific GDPR PDF.

Responses:
  200 OK:
    Description: Das gewünschte Vertrags-PDF
    Content:
      application/json:
        Schema: GDPRPDF (see Get GDPR PDF Response Schema)
  403 Forbidden:
    Description: Authentication or authorization error.

Usage Examples:
  cURL:
    $ curl \
        --fail \
        --location \
        -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
        https://api.mittwald.de/v1/gdpr/pdfs/string
```

--------------------------------

### Mittwald API 200 OK Response Example

Source: https://developer.mittwald.de/docs/v1/reference/navigation/search

An example JSON payload representing a successful response (200 OK) from the Mittwald API, illustrating the structure for accounts, resellers, and solr data.

```json
{
  "accounts": [
    {
      "account_uid": 123,
      "account_name": "string",
      "account_desc": "string",
      "dom_list": "string"
    }
  ],
  "reseller": [
    {
      "reseller_uid": 123,
      "reseller_name": "string",
      "reseller_desc": "string"
    }
  ],
  "solr": [
    {
      "solr_uid": 123,
      "solr_name": "string"
    }
  ]
}
```

--------------------------------

### Mittwald API v1 Introduction

Source: https://developer.mittwald.de/docs/v1/reference/dsgvoverträge

Provides an overview of the Mittwald Developer Portal API v1, stating its maintenance status and recommending API v2 for current development.

```APIDOC
API Version: v1
Status: Maintained, not actively developed.
Recommendation: Use API v2 for up-to-date documentation and features.
```

--------------------------------

### Get Webhook Example (cURL)

Source: https://developer.mittwald.de/docs/v1/reference/webhooks/getWebhook

This example shows how to fetch webhook data from the Mittwald API using cURL. It includes setting the Authorization header with a bearer token and using the --fail option for error handling.

```bash
$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/webhooks/string

```

--------------------------------

### Application Token Response Example

Source: https://developer.mittwald.de/docs/v1/reference/authentifizierung/createApplicationToken

Example JSON structure for a successful application token creation response, containing token details.

```json
{
  "uuid": "f0f86186-0a5a-45b2-aa33-502777496347",
  "crdate": "2025-07-28T10:37:25.365Z",
  "token": "string",
  "description": "string"
}
```

--------------------------------

### Get Support Ticket Response

Source: https://developer.mittwald.de/docs/v1/reference/tickets/getSupportTicket

Details the structure and content of a successful API response when retrieving a support ticket. Includes the JSON schema and an example payload.

```APIDOC
API Endpoint: GET /v1/tickets/{ticketId}

Description: Retrieves details for a specific support ticket.

Response (200 OK):
  Format: application/json
  Description: Angefragtes Ticket

  Schema Documentation:
  * uid: integer (required)
  * subject: string (required)
  * message: string (required)
  * createdAt: string (datetime) (required)
  * updatedAt: string (datetime) (required)
  * status: string (one of: open, in-progress, feedback, information, answered, done) (required)
  * publicStatus: string (one of: open, in-progress, feedback, information, answered, done) (required)
  * author: object (required)
    + name: string (required)
    + email: string (email) (required)
    + telephone: string (required)
    + isMittwaldAuthor: boolean (required)
  * account: object
    + uid: integer (required)
    + name: string (required)
  * customer: object
    + customernumber: integer (required)
  * answersCount: integer (required)
  * files: array of string (uuid)
    + Array[
    + * string (uuid)
    + ]

Example JSON Payload:
```json
{
  "uid": 123,
  "subject": "string",
  "message": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "status": "open",
  "publicStatus": "open",
  "author": {
    "name": "string",
    "email": "email@mittwald.example",
    "telephone": "string",
    "isMittwaldAuthor": true
  },
  "account": {
    "uid": 123,
    "name": "string"
  },
  "customer": {
    "customernumber": 123
  },
  "answersCount": 123,
  "files": [
    "f0f86186-0a5a-45b2-aa33-502777496347"
  ]
}
```

JSON Schema:
```json
{
  "title": "Ticket",
  "required": [
    "answersCount",
    "author",
    "createdAt",
    "updatedAt",
    "message",
    "status",
    "publicStatus",
    "subject",
    "uid"
  ],
  "type": "object",
  "properties": {
    "uid": {
      "type": "integer"
    },
    "subject": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "updatedAt": {
      "type": "string",
      "format": "datetime"
    },
    "status": {
      "title": "TicketStatus",
      "type": "string",
      "enum": [
        "open",
        "in-progress",
        "feedback",
        "information",
        "answered",
        "done"
      ]
    },
    "publicStatus": {
      "title": "TicketStatus",
      "type": "string",
      "enum": [
        "open",
        "in-progress",
        "feedback",
        "information",
        "answered",
        "done"
      ]
    },
    "author": {
      "required": [
        "email",
        "name",
        "telephone",
        "isMittwaldAuthor"
      ],
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "email": {
          "type": "string",
          "format": "email"
        },
        "telephone": {
          "type": "string"
        },
        "isMittwaldAuthor": {
          "type": "boolean"
        }
      }
    },
    "account": {
      "required": [
        "name",
        "uid"
      ],
      "type": "object",
      "properties": {
        "uid": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "customer": {
      "required": [
        "customernumber"
      ],
      "type": "object",
      "properties": {
        "customernumber": {
          "type": "integer"
        }
      }
    },
    "answersCount": {
      "type": "integer"
    },
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    }
  }
}
```
```

```bash
$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/tickets/string
```

--------------------------------

### Get Top Level Domain Details

Source: https://developer.mittwald.de/docs/v1/reference/domains/getToplevelDomain

Retrieves detailed information for a specific Top Level Domain. Includes response format, JSON schema, and a cURL example for making the request.

```APIDOC
GET /v1/topleveldomains/{domain}

Description:
Retrieves details for a specific Top Level Domain.

Parameters:
- domain (string, required): The Top Level Domain to retrieve.
- fields (string, optional): Comma-separated list of fields to include in the response.

Responses:
- 200 OK:
  Content-Type: application/json
  Description: Successful retrieval of Top Level Domain information.
  Body:
    - uid (integer): Unique identifier.
    - name (string): The name of the Top Level Domain.
    - description (string): A description of the Top Level Domain.
    - articleNumber (integer): Article number associated with the domain.
    - price (string): The price of the domain.
    - agencyPrice (string): The agency price for the domain.
    - setupFee (string): The setup fee for the domain.
    - isAllowedAsInclusiveDomain (boolean): Indicates if the domain can be used as an inclusive domain.

Example Response Body:
```json
{
  "uid": 123,
  "name": "string",
  "description": "string",
  "articleNumber": 123,
  "price": "string",
  "agencyPrice": "string",
  "setupFee": "string",
  "isAllowedAsInclusiveDomain": true
}
```

JSON Schema:
```json
{
  "title": "TopLevelDomain",
  "type": "object",
  "properties": {
    "uid": {
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "articleNumber": {
      "type": "integer"
    },
    "price": {
      "type": "string"
    },
    "agencyPrice": {
      "type": "string"
    },
    "setupFee": {
      "type": "string"
    },
    "isAllowedAsInclusiveDomain": {
      "type": "boolean"
    }
  }
}
```

Usage Examples:
- cURL:
```bash
$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/topleveldomains/string?fields=string
```
```

--------------------------------

### Get Cronjob Interpreters (cURL)

Source: https://developer.mittwald.de/docs/v1/reference/cronjob/getCronjobInterpreters

This example demonstrates how to fetch a list of available cronjob interpreters using cURL. It requires an authorization token and targets the specific API endpoint for interpreters.

```bash
curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/cronjobs/interpreter
```

--------------------------------

### Customer Partner Response Example (JSON)

Source: https://developer.mittwald.de/docs/v1/reference/kunden/updateCustomerContractPartner

An example JSON payload representing a successful response for retrieving customer partner details.

```JSON
{
  "firstName": "string",
  "lastName": "string",
  "title": "string",
  "salutation": "string",
  "company": "string",
  "address": {
    "street": "string",
    "houseNumber": "string",
    "zip": "string",
    "city": "string",
    "country": {
      "isoShort": "string",
      "isoLong": "string",
      "euMember": true,
      "name": {
        "de": "string",
        "en": "string"
      }
    }
  },
  "contact": {
    "telephone": "string",
    "fax": "string",
    "email": "email@mittwald.example"
  }
}
```

--------------------------------

### Get GDPR Contact (cURL)

Source: https://developer.mittwald.de/docs/v1/reference/dsgvokontakte/getGDPRContact

This example demonstrates how to retrieve GDPR contact information using a cURL command. It includes the necessary authorization header and the target API endpoint for making the request.

```bash
$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/gdpr/contacts/string
```

--------------------------------

### cURL Example to List Accounts

Source: https://developer.mittwald.de/docs/v1/reference/kunden/listAccountsByCustomer

Demonstrates how to call the API endpoint using cURL to fetch accounts for a specific customer. It includes setting the Authorization header and constructing the URL with query parameters.

```bash
$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/customers/123/accounts?advised=true&owned=true&fields=string
```

--------------------------------

### Example cURL Request to Get Cronjob

Source: https://developer.mittwald.de/docs/v1/reference/cronjob/getCronjob

Demonstrates how to fetch cronjob details using cURL, including setting the Authorization header and specifying the API endpoint with placeholders for account and cronjob IDs.

```bash
$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/accounts/string/cronjobs/string
```