Getting started
Back to home
Getting started

Get runtime status

Check the current runtime and deployment state. The response identifies cached results and reports pending deployment or crash-loop conditions.

GET/api/customer/v1/projects/{projectId}/status

Path parameters

NameValue
projectIdRequired resource ID from an earlier API response.

Example request

Set HCODE_BASE_URL and HCODE_API_KEY as shown in Getting started. Replace resource variables with your own IDs.

curl --request GET "$HCODE_BASE_URL/api/customer/v1/projects/${PROJECT_ID}/status" \
  --header "Authorization: Bearer $HCODE_API_KEY"

Response

The JSON shape is defined in the response schema.

Response schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "cached": {
      "type": "boolean"
    },
    "crashLoop": {
      "type": "boolean"
    },
    "deploymentInProgress": {
      "type": "boolean"
    }
  },
  "required": [
    "status"
  ],
  "additionalProperties": true
}

See errors and retries for failure responses.