Create an Ingress

POST/ingresses/

API version

v2

Request method

POST

Operation ID

ingress-create-ingress

---

Request

Responses

Format

application/json

Beschreibung

Created

Schema-Dokumentation

• idstring (uuid)

  required
• ownershipobject

  required
  • txtRecordstring
  • verifiedboolean

    required

    Whether the domain ownership is verified or not.

Beispiel

{
  "id": "f0f86186-0a5a-45b2-aa33-502777496347",
  "ownership": {
    "txtRecord": "string",
    "verified": true
  }
}

JSON Schema

{
  "properties": {
    "id": {
      "format": "uuid",
      "type": "string"
    },
    "ownership": {
      "properties": {
        "txtRecord": {
          "type": "string"
        },
        "verified": {
          "description": "Whether the domain ownership is verified or not.",
          "type": "boolean"
        }
      },
      "required": [
        "verified"
      ],
      "type": "object"
    }
  },
  "required": [
    "id",
    "ownership"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"hostname":"some-hostname.example","paths":[{"path":"/","target":{"useDefaultPage":true}},{"path":"/redirect","target":{"url":"https://some-redirect.example"}},{"path":"/path-to-dir","target":{"directory":"/public"}},{"path":"/path-to-app","target":{"installationId":"e1ccfde2-8983-4529-ae66-23a7e34c1177"}},{"path":"/path-to-container","target":{"container":{"id":"ead3223c-6f23-4eaf-8250-392f10b49a35","portProtocol":"80/tcp"}}}],"projectId":"f0f86186-0a5a-45b2-aa33-502777496347"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/ingresses

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.domain.ingressCreateIngress({
  "data": {
    "hostname": "some-hostname.example",
    "paths": [
      {
        "path": "/",
        "target": {
          "useDefaultPage": true
        }
      },
      {
        "path": "/redirect",
        "target": {
          "url": "https://some-redirect.example"
        }
      },
      {
        "path": "/path-to-dir",
        "target": {
          "directory": "/public"
        }
      },
      {
        "path": "/path-to-app",
        "target": {
          "installationId": "e1ccfde2-8983-4529-ae66-23a7e34c1177"
        }
      },
      {
        "path": "/path-to-container",
        "target": {
          "container": {
            "id": "ead3223c-6f23-4eaf-8250-392f10b49a35",
            "portProtocol": "80/tcp"
          }
        }
      }
    ],
    "projectId": "f0f86186-0a5a-45b2-aa33-502777496347"
  }
});

assertStatus(response, 201);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Domain\IngressCreateIngress\IngressCreateIngressRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Domain\IngressCreateIngress\IngressCreateIngressRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// IngressCreateIngressRequestBody to learn how to construct a valid instance
$body = new IngressCreateIngressRequestBody(/* TODO: ... */);

$request = (new IngressCreateIngressRequest(
  body: $body
));
$response = $client->domain()->ingressCreateIngress($request);

var_dump($response->getBody();