List Certificates belonging to a Project or an Ingress

GET/certificates/

API version

v2

Request method

GET

Operation ID

ssl-list-certificates

---

Request

Responses

Format

application/json

Description

OK

Schema documentation

• Array[
• *object
  • caBundlestring
  • certificatestring

    required
  • certificateOrderIdstring (uuid)
  • certificateRequestIdstring (uuid)

    required
  • certificateTypeinteger (one of: 0, 1, 2)

    required
  • commonNamestring
  • contactobject
    • citystring
    • companystring
    • countrystring

      Two letter abbreviation - country code (ISO 3166-1 Alpha-2).

    • organizationalUnitstring
    • statestring
  • dnsNamesarray of string
    • Array[
    • *string
    ]
• idstring (uuid)

  required
• isExpiredboolean

  required
• issuerstring
• lastExpirationThresholdHitinteger

  required
• projectIdstring (uuid)

  required
• validFromstring (date-time)

  required
• validTostring (date-time)

  required

]

Example

[
  {
    "caBundle": "string",
    "certificate": "string",
    "certificateOrderId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "certificateRequestId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "certificateType": 123,
    "commonName": "string",
    "contact": {
      "city": "string",
      "company": "string",
      "country": "DE",
      "organizationalUnit": "string",
      "state": "string"
    },
    "dnsNames": [
      "string"
    ],
    "id": "f0f86186-0a5a-45b2-aa33-502777496347",
    "isExpired": true,
    "issuer": "string",
    "lastExpirationThresholdHit": 123,
    "projectId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "validFrom": "2024-11-21T11:15:10.239Z",
    "validTo": "2024-11-21T11:15:10.239Z"
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "caBundle": {
        "type": "string"
      },
      "certificate": {
        "type": "string"
      },
      "certificateOrderId": {
        "format": "uuid",
        "type": "string"
      },
      "certificateRequestId": {
        "format": "uuid",
        "type": "string"
      },
      "certificateType": {
        "enum": [
          0,
          1,
          2
        ],
        "type": "integer"
      },
      "commonName": {
        "type": "string"
      },
      "contact": {
        "properties": {
          "city": {
            "type": "string"
          },
          "company": {
            "type": "string"
          },
          "country": {
            "description": "Two letter abbreviation - country code (ISO 3166-1 Alpha-2).",
            "example": "DE",
            "pattern": "^[A-Z]{2}$",
            "type": "string"
          },
          "organizationalUnit": {
            "type": "string"
          },
          "state": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "dnsNames": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "id": {
        "format": "uuid",
        "type": "string"
      },
      "isExpired": {
        "type": "boolean"
      },
      "issuer": {
        "type": "string"
      },
      "lastExpirationThresholdHit": {
        "type": "integer"
      },
      "projectId": {
        "format": "uuid",
        "type": "string"
      },
      "validFrom": {
        "format": "date-time",
        "type": "string"
      },
      "validTo": {
        "format": "date-time",
        "type": "string"
      }
    },
    "required": [
      "id",
      "certificateType",
      "certificateRequestId",
      "projectId",
      "validFrom",
      "validTo",
      "certificate",
      "isExpired",
      "lastExpirationThresholdHit"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/certificates?projectId=f0f86186-0a5a-45b2-aa33-502777496347&ingressId=f0f86186-0a5a-45b2-aa33-502777496347

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.sslListCertificates({
  "queryParameters": {
    "projectId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "ingressId": "f0f86186-0a5a-45b2-aa33-502777496347"
  }
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new SslListCertificatesRequest())
  ->withProjectId("f0f86186-0a5a-45b2-aa33-502777496347")
  ->withIngressId("f0f86186-0a5a-45b2-aa33-502777496347");
$response = $client->domain()->sslListCertificates($request);

var_dump($response->getBody();