curl --request GET \
--url https://app.hookie.ai/admin/api/projects/{pid}/config \
--cookie hookie_session=const options = {method: 'GET', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/projects/{pid}/config', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/projects/{pid}/config"
headers = {"cookie": "hookie_session="}
response = requests.get(url, headers=headers)
print(response.text){
"version": 1,
"project": "<string>",
"endpoints": [
{}
],
"rules": [
{}
],
"destinations": [
{}
],
"ai_agents": [
{}
],
"workflows": [
{}
],
"triggers": [
{}
],
"cron_triggers": [
{}
],
"record_views": [
{}
],
"not_exported": [
{
"kind": "<string>",
"count": 123,
"reason": "<string>"
}
]
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}Export a project's configuration
The project’s configuration as JSON, or as YAML with ?format=yaml (the subset hookie apply reads). Readable by any role (DX-10, #201).
curl --request GET \
--url https://app.hookie.ai/admin/api/projects/{pid}/config \
--cookie hookie_session=const options = {method: 'GET', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/projects/{pid}/config', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/projects/{pid}/config"
headers = {"cookie": "hookie_session="}
response = requests.get(url, headers=headers)
print(response.text){
"version": 1,
"project": "<string>",
"endpoints": [
{}
],
"rules": [
{}
],
"destinations": [
{}
],
"ai_agents": [
{}
],
"workflows": [
{}
],
"triggers": [
{}
],
"cron_triggers": [
{}
],
"record_views": [
{}
],
"not_exported": [
{
"kind": "<string>",
"count": 123,
"reason": "<string>"
}
]
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}Authorizations
The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.
Path Parameters
Project id (UUID) belonging to the caller workspace.
Query Parameters
json, yaml Response
The document.
A project's configuration (DX-10, #201) — the hookie.yml shape, so hookie apply reads an export as it is. NOTHING SECRET IS IN IT: no endpoint URL (its slug is the credential), endpoint verification secret, destination signing secret or ingest key. Sources, WebSocket triggers and portals hold encrypted credentials and are listed under not_exported instead. Identity per kind: an endpoint's slug, a record view's dataset + name, everything else's name.
The source project's slug; informational.
Informational; an import ignores it.
Show child attributes
Show child attributes