Get an onboarding website
import requests
url = "https://api.platform.ankra.app/org/onboarding/websites/{website_id}"
headers = {"cookie": "ankra_session="}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {cookie: 'ankra_session='}};
fetch('https://api.platform.ankra.app/org/onboarding/websites/{website_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://api.platform.ankra.app/org/onboarding/websites/{website_id} \
--cookie ankra_session={
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "queued",
"prompt": "<string>",
"title": "<string>",
"summary": "<string>",
"url": "<string>",
"target_kind": "starter",
"application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"repository_url": "<string>",
"message": "<string>",
"template": "<string>",
"theme": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}Onboarding
Get an onboarding website
One generated website and its progress. Browser-session route.
GET
/
org
/
onboarding
/
websites
/
{website_id}
Get an onboarding website
import requests
url = "https://api.platform.ankra.app/org/onboarding/websites/{website_id}"
headers = {"cookie": "ankra_session="}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {cookie: 'ankra_session='}};
fetch('https://api.platform.ankra.app/org/onboarding/websites/{website_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://api.platform.ankra.app/org/onboarding/websites/{website_id} \
--cookie ankra_session={
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "queued",
"prompt": "<string>",
"title": "<string>",
"summary": "<string>",
"url": "<string>",
"target_kind": "starter",
"application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"repository_url": "<string>",
"message": "<string>",
"template": "<string>",
"theme": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}Authorizations
Browser session. Mutations also require X-Ankra-CSRF.
Path Parameters
Response
The website.
One website generation of the onboarding wizard.
Available options:
queued, generating, deploying, live, failed Available options:
starter, repository The starter the site was built from; null when it was written from the prompt alone.
The palette picked for the site; null keeps the starter's own or the default.