Get a CertificateRequest

GET/certificate-requests/{certificateRequestId}/

API version

v2

Request method

GET

Operation ID

ssl-get-certificate-request

---

Request

• certificateRequestIdstring (uuid)

  required

  ID of the CertificateRequest to be retrieved.

Responses

Format

application/json

Description

OK

Schema documentation

• certificateDataobject

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

  required
• commonNamestring
• contactobject
  • citystring
  • companystring
  • countrystring

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

  • organizationalUnitstring
  • statestring
• createdAtstring (date-time)

  required
• dnsNamesarray of string
  • Array[
  • *string
  ]

idstring (uuid)

required

isCompletedboolean

required

issuerstring

projectIdstring (uuid)

required

validFromstring (date-time)

validTostring (date-time)

Example

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

JSON Schema

{
  "properties": {
    "certificateData": {
      "properties": {
        "caBundle": {
          "type": "string"
        },
        "certificate": {
          "type": "string"
        },
        "signingRequest": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "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"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "dnsNames": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "id": {
      "format": "uuid",
      "type": "string"
    },
    "isCompleted": {
      "type": "boolean"
    },
    "issuer": {
      "type": "string"
    },
    "projectId": {
      "format": "uuid",
      "type": "string"
    },
    "validFrom": {
      "format": "date-time",
      "type": "string"
    },
    "validTo": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "id",
    "certificateType",
    "projectId",
    "certificateData",
    "isCompleted",
    "createdAt"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/certificate-requests/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.sslGetCertificateRequest({
  "certificateRequestId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new SslGetCertificateRequestRequest(
  certificateRequestId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->domain()->sslGetCertificateRequest($request);

var_dump($response->getBody();