<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"id": "<string>",
"type": "certificates",
"links": {
"self": {
"href": "<string>",
"rel": "<string>",
"describedby": "<string>",
"title": "<string>",
"type": "<string>",
"hreflang": "<string>",
"meta": {}
}
},
"attributes": {
"type": "letsencrypt",
"verification_method": "http-01",
"key_type": "ecdsa",
"preferred_chain": "ISRG Root X1",
"request_status": "verifying",
"status": "installing",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
}Get the certificate for a given domain.
Processing mode: sync
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"id": "<string>",
"type": "certificates",
"links": {
"self": {
"href": "<string>",
"rel": "<string>",
"describedby": "<string>",
"title": "<string>",
"type": "<string>",
"hreflang": "<string>",
"meta": {}
}
},
"attributes": {
"type": "letsencrypt",
"verification_method": "http-01",
"key_type": "ecdsa",
"preferred_chain": "ISRG Root X1",
"request_status": "verifying",
"status": "installing",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
}The access token received from the authorization server in the OAuth 2.0 flow.
The organization slug
The server ID
The site ID
The domain record ID
CertificateResource
Show child attributes
certificates Show child attributes
Show child attributes
The type of certificate.
letsencrypt, csr, existing The verification method for Let's Encrypt certificates.
http-01, dns-01 "http-01"
The key type for Let's Encrypt certificates.
ecdsa, rsa "ecdsa"
The preferred chain for Let's Encrypt certificates.
ISRG Root X1 The certificate request status.
verifying, creating, created The status of the certificate.
installing, installed, removing, restarting, stopping, stopped, starting, syncing, updating, disabling, disabled, enabling, running, restoring, deleting, failed, success, failed-unknown, failed-runner, renewing The date and time the certificate was created.
The date and time the certificate was last updated.
Was this page helpful?