Skip to main content

get_project

Read one project's detail document: identity, base URL, execution target, and the configured test site URLs.

Request

GET /api/v1/ops/projects/{project}
ParameterInTypeRequiredDescription
projectpathstringyesThe project's public id.
curl -H "Authorization: Bearer $TESTVIBE_API_KEY" \
"$TESTVIBE_SERVER/api/v1/ops/projects/$PROJECT"

Response

{
"id": "a1b2c3d4-…",
"name": "Demo Shop",
"baseUrl": "https://demo.example",
"executionTarget": "sandbox",
"testSiteUrls": [
{ "url": "https://demo.example", "isDefault": true },
{ "url": "https://staging.demo.example", "isDefault": false }
]
}

testSiteUrls are the candidate targets for the siteUrl override on run_feature, run_suite, and generate_feature; the default one is used when no override is given.

Errors

HTTPWhen
404 not_foundNo such project in this workspace.