Get a deployment

curl --request GET \     --url https://radiantdocs.com/v1/deployments/{deploymentId} \     --header 'accept: application/json' \     --header 'authorization: Bearer <BEARER_TOKEN>'

const options = {  method: 'GET',  headers: {accept: 'application/json', authorization: 'Bearer <BEARER_TOKEN>'}};fetch('https://radiantdocs.com/v1/deployments/{deploymentId}', options)  .then(res => res.json())  .then(res => console.log(res))  .catch(err => console.error(err));

import requestsurl = "https://radiantdocs.com/v1/deployments/{deploymentId}"headers = {    "accept": "application/json",    "authorization": "Bearer <BEARER_TOKEN>"}response = requests.get(url, headers=headers)print(response.text)

package mainimport (	"fmt"	"net/http"	"io")func main() {	url := "https://radiantdocs.com/v1/deployments/{deploymentId}"	req, _ := http.NewRequest("GET", url, nil)	req.Header.Add("accept", "application/json")	req.Header.Add("authorization", "Bearer <BEARER_TOKEN>")	res, _ := http.DefaultClient.Do(req)	defer res.Body.Close()	body, _ := io.ReadAll(res.Body)	fmt.Println(string(body))}

OkHttpClient client = new OkHttpClient();Request request = new Request.Builder()  .url("https://radiantdocs.com/v1/deployments/{deploymentId}")  .get()  .addHeader("accept", "application/json")  .addHeader("authorization", "Bearer <BEARER_TOKEN>")  .build();Response response = client.newCall(request).execute();

<?phprequire_once('vendor/autoload.php');$client = new \GuzzleHttp\Client();$response = $client->request('GET', 'https://radiantdocs.com/v1/deployments/{deploymentId}', [  'headers' => [    'accept' => 'application/json',    'authorization' => 'Bearer <BEARER_TOKEN>',  ],]);echo $response->getBody();

{  "id": "90a76b22-8f25-4fc7-95cc-b3a5b2f24108",  "siteId": "25853bf0-7640-45c6-b008-568c6d90d8f8",  "status": "building",  "trigger": "api",  "commit": {    "sha": "4f91d8616e87bb258320565ff3eeca7c1f5f260b",    "message": "Update authentication documentation"  },  "failure": {    "message": "The docs configuration is invalid."  },  "createdAt": "2026-08-01T18:30:00.000Z",  "updatedAt": "2026-08-01T18:30:06.000Z"}

{  "error": {    "code": "not_found",    "message": "Deployment not found.",    "details": {}  }}

{  "error": {    "code": "not_found",    "message": "Deployment not found.",    "details": {}  }}

{  "error": {    "code": "not_found",    "message": "Deployment not found.",    "details": {}  }}

{  "error": {    "code": "not_found",    "message": "Deployment not found.",    "details": {}  }}

GET/v1/deployments/{deploymentId}Copy

Returns the current status of one deployment belonging to the API key's site.

curl --request GET \     --url https://radiantdocs.com/v1/deployments/{deploymentId} \     --header 'accept: application/json' \     --header 'authorization: Bearer <BEARER_TOKEN>'

const options = {  method: 'GET',  headers: {accept: 'application/json', authorization: 'Bearer <BEARER_TOKEN>'}};fetch('https://radiantdocs.com/v1/deployments/{deploymentId}', options)  .then(res => res.json())  .then(res => console.log(res))  .catch(err => console.error(err));

import requestsurl = "https://radiantdocs.com/v1/deployments/{deploymentId}"headers = {    "accept": "application/json",    "authorization": "Bearer <BEARER_TOKEN>"}response = requests.get(url, headers=headers)print(response.text)

package mainimport (	"fmt"	"net/http"	"io")func main() {	url := "https://radiantdocs.com/v1/deployments/{deploymentId}"	req, _ := http.NewRequest("GET", url, nil)	req.Header.Add("accept", "application/json")	req.Header.Add("authorization", "Bearer <BEARER_TOKEN>")	res, _ := http.DefaultClient.Do(req)	defer res.Body.Close()	body, _ := io.ReadAll(res.Body)	fmt.Println(string(body))}

OkHttpClient client = new OkHttpClient();Request request = new Request.Builder()  .url("https://radiantdocs.com/v1/deployments/{deploymentId}")  .get()  .addHeader("accept", "application/json")  .addHeader("authorization", "Bearer <BEARER_TOKEN>")  .build();Response response = client.newCall(request).execute();

<?phprequire_once('vendor/autoload.php');$client = new \GuzzleHttp\Client();$response = $client->request('GET', 'https://radiantdocs.com/v1/deployments/{deploymentId}', [  'headers' => [    'accept' => 'application/json',    'authorization' => 'Bearer <BEARER_TOKEN>',  ],]);echo $response->getBody();

{  "id": "90a76b22-8f25-4fc7-95cc-b3a5b2f24108",  "siteId": "25853bf0-7640-45c6-b008-568c6d90d8f8",  "status": "building",  "trigger": "api",  "commit": {    "sha": "4f91d8616e87bb258320565ff3eeca7c1f5f260b",    "message": "Update authentication documentation"  },  "failure": {    "message": "The docs configuration is invalid."  },  "createdAt": "2026-08-01T18:30:00.000Z",  "updatedAt": "2026-08-01T18:30:06.000Z"}

{  "error": {    "code": "not_found",    "message": "Deployment not found.",    "details": {}  }}

{  "error": {    "code": "not_found",    "message": "Deployment not found.",    "details": {}  }}

{  "error": {    "code": "not_found",    "message": "Deployment not found.",    "details": {}  }}

{  "error": {    "code": "not_found",    "message": "Deployment not found.",    "details": {}  }}

Header

Authorizationstring required

A site-scoped key created from the Radiant dashboard.

Path Parameters

deploymentIdstring (uuid) required

The deployment identifier returned when the deployment was created.

Responses

200

The deployment and its current status.

idstring (uuid) required

siteIdstring (uuid) required

statusenum<string> required

Options:

queued,

building,

success,

failed or

canceled

triggerstring required

The workflow that created the deployment.

commitobject required

shastring required

messagestringnull required

failureobject | null required

One of these variants applies.

object

messagestring required

createdAtstring (date-time) required

updatedAtstring (date-time) required

401

The request is missing a valid, active Radiant API key.

errorobject required

codestring required

messagestring required

detailsobject

[key: string]any

403

The API key does not have the scope required by the operation.

errorobject required

codestring required

messagestring required

detailsobject

[key: string]any

404

The resource does not exist or is outside the API key's site scope.

errorobject required

codestring required

messagestring required

detailsobject

[key: string]any

500

Radiant could not complete the request because of an internal error.

errorobject required

codestring required

messagestring required

detailsobject

[key: string]any