curl --request GET \
--url https://app.ohmyho.st/v1/projects/{project_id}/status \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.ohmyho.st/v1/projects/{project_id}/status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.ohmyho.st/v1/projects/{project_id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.ohmyho.st/v1/projects/{project_id}/status",
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;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.ohmyho.st/v1/projects/{project_id}/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.ohmyho.st/v1/projects/{project_id}/status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.ohmyho.st/v1/projects/{project_id}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"etag": "<string>",
"project_id": "<string>",
"handle": "<string>",
"region": "us",
"dev_access_mode": "protected",
"lifecycle": "active",
"source": {
"provider": "github",
"installation_id": "<string>",
"repository_full_name": "<string>",
"status": "pending",
"linked_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"failure_summary": "<string>"
},
"default_environment": {
"id": "<string>",
"name": "<string>"
},
"head_deployment": {
"id": "<string>",
"project_id": "<string>",
"operation_id": "<string>",
"commit_sha": "<string>",
"source_digest": "<string>",
"build_plan_digest": "<string>",
"status": "queued",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"artifact_digest": "<string>",
"url": "<string>"
},
"dev_url": "<string>",
"prod_url": "<string>",
"latest_operation": {
"id": "<string>",
"state": "queued",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"blocking_operation_id": "<string>",
"deployment_id": "<string>",
"result": {},
"error": {
"code": "operation_failed",
"message": "<string>",
"retryable": false,
"suggested_action": "<string>",
"migration": {
"reason": "catalog_changed",
"file": "<string>",
"statement_index": 4503599627370496,
"sqlstate": "<string>"
},
"detail": "<string>"
},
"progress": {
"phase": "queued",
"project_id": "<string>",
"deployment_id": "<string>",
"observed_at": "2023-11-07T05:31:56Z",
"next_poll_after_seconds": 60,
"suggested_action": "<string>",
"mail": {
"domain": "<string>",
"status": "configured",
"configured_at": "2023-11-07T05:31:56Z",
"dns_records": [
{
"type": "MX",
"name": "<string>",
"value": "<string>",
"status": "<string>",
"priority": 32767
}
],
"observed_at": "2023-11-07T05:31:56Z",
"verification_issue": "identity_missing",
"next_check_after_seconds": 60,
"sending": "disabled",
"receiving": "disabled"
},
"build_completed_at": "2023-11-07T05:31:56Z"
},
"reconciliation": {
"state": "required",
"attempt_id": "<string>",
"observed_at": "2023-11-07T05:31:56Z",
"suggested_action": "<string>"
}
},
"cleanup_state": "not_started",
"custom_domains": [
{
"hostname": "<string>",
"environment": "prod",
"state": "awaiting_deployment"
}
],
"environments": [
{
"id": "<string>",
"name": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "https://docs.ohmyho.st/errors/resource-not-found",
"title": "Resource not found",
"status": 404,
"code": "resource_not_found",
"request_id": "req_01J00000000000000000000000",
"retryable": false,
"suggested_action": "Check the resource identifier and your access scope."
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}Get the current project deployment status
Returns the immutable project handle, current source, default environment, head deployment, independently evidenced dev and prod gateway origins, latest operation, and cleanup state without exposing provider credentials.
curl --request GET \
--url https://app.ohmyho.st/v1/projects/{project_id}/status \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.ohmyho.st/v1/projects/{project_id}/status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.ohmyho.st/v1/projects/{project_id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.ohmyho.st/v1/projects/{project_id}/status",
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;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.ohmyho.st/v1/projects/{project_id}/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.ohmyho.st/v1/projects/{project_id}/status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.ohmyho.st/v1/projects/{project_id}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"etag": "<string>",
"project_id": "<string>",
"handle": "<string>",
"region": "us",
"dev_access_mode": "protected",
"lifecycle": "active",
"source": {
"provider": "github",
"installation_id": "<string>",
"repository_full_name": "<string>",
"status": "pending",
"linked_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"failure_summary": "<string>"
},
"default_environment": {
"id": "<string>",
"name": "<string>"
},
"head_deployment": {
"id": "<string>",
"project_id": "<string>",
"operation_id": "<string>",
"commit_sha": "<string>",
"source_digest": "<string>",
"build_plan_digest": "<string>",
"status": "queued",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"artifact_digest": "<string>",
"url": "<string>"
},
"dev_url": "<string>",
"prod_url": "<string>",
"latest_operation": {
"id": "<string>",
"state": "queued",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"blocking_operation_id": "<string>",
"deployment_id": "<string>",
"result": {},
"error": {
"code": "operation_failed",
"message": "<string>",
"retryable": false,
"suggested_action": "<string>",
"migration": {
"reason": "catalog_changed",
"file": "<string>",
"statement_index": 4503599627370496,
"sqlstate": "<string>"
},
"detail": "<string>"
},
"progress": {
"phase": "queued",
"project_id": "<string>",
"deployment_id": "<string>",
"observed_at": "2023-11-07T05:31:56Z",
"next_poll_after_seconds": 60,
"suggested_action": "<string>",
"mail": {
"domain": "<string>",
"status": "configured",
"configured_at": "2023-11-07T05:31:56Z",
"dns_records": [
{
"type": "MX",
"name": "<string>",
"value": "<string>",
"status": "<string>",
"priority": 32767
}
],
"observed_at": "2023-11-07T05:31:56Z",
"verification_issue": "identity_missing",
"next_check_after_seconds": 60,
"sending": "disabled",
"receiving": "disabled"
},
"build_completed_at": "2023-11-07T05:31:56Z"
},
"reconciliation": {
"state": "required",
"attempt_id": "<string>",
"observed_at": "2023-11-07T05:31:56Z",
"suggested_action": "<string>"
}
},
"cleanup_state": "not_started",
"custom_domains": [
{
"hostname": "<string>",
"environment": "prod",
"state": "awaiting_deployment"
}
],
"environments": [
{
"id": "<string>",
"name": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "https://docs.ohmyho.st/errors/resource-not-found",
"title": "Resource not found",
"status": 404,
"code": "resource_not_found",
"request_id": "req_01J00000000000000000000000",
"retryable": false,
"suggested_action": "Check the resource identifier and your access scope."
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}Authorizations
Headers
Response
The current tenant-scoped project status.
Chosen at project creation and immutable through customer operations. us (default) or eu places new build resources and, when no storage is already assigned, new file buckets. Existing buckets, source repositories and historical artifacts retain their recorded locations independently of a platform-authorized project-region migration. New PGCF application databases follow the selected project region; existing owner-authorized migrations target US1. Read database compute for the actual database region. storage.jurisdiction must match the project's recorded storage location, or this region when no storage custody exists. Project context reports the authoritative storage jurisdiction. Prices are identical in both project regions.
us, eu Durable record returned for an accepted asynchronous mutation. Optional reconciliation is a current observation for queued/running work, separate from immutable terminal state. A completed reconciliation attempt alone does not mean the operation succeeded.
Show child attributes
Show child attributes