OpenVibe.Host API
Generated at from
openvibe-contracts v0.114.0 and
openvibe-sdk v0.35.1.
Server https://openvibe.host. 36 routes performing 5 capabilities. OpenAPI 3.1 document.
GET /api/v1/deploys/{id}
Upload an immutable static deploy (tar/tar.gz or multipart files; validated for path traversal, links, special and hidden files, server-side code, file types and quotas; never executed), list deploys
- Capabilities
- host.deploy.create
- Visibility
- first-party
- Parameters
id(path, required)
- Input
- host.deploy-create-request@1
- Response
application/jsonhost.deploy-create-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.deploy.create</strong> (first-party): Upload an immutable static deploy (tar/tar.gz or multipart files; validated for path traversal, links, special and hidden files, server-side code, file types and quotas; never executed), list deploys and their upload logs, activate a deploy and roll a site back to any earlier ready deploy (one atomic pointer switch). Also judged by the acting principal's project role (deployer or above); an app principal added to a project as deployer can deploy from CI. A site with a Git source also accepts a CI-built deploy at /sites/:id/source/deploys naming the ref and full commit_sha; it is always a preview and records that commit as immutable provenance.</p>DELETE /api/v1/deploys/{id}
Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner
- Capabilities
- host.site.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Input
- host.site-manage-request@1
- Response
application/jsonhost.site-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.manage</strong> (first-party): Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner role), create and delete sites, delete a deploy that is not active. Also judged by the acting principal's project role; a sandbox token (env=sandbox) is refused on production projects. Quota changes and takedowns (stop serving a site or a whole project while keeping its content for review; lift) additionally need a Network staff user. Read, set or remove a site's Git source (provider, public repository URL and branch; never a credential).</p>POST /api/v1/deploys/{id}/activate
Upload an immutable static deploy (tar/tar.gz or multipart files; validated for path traversal, links, special and hidden files, server-side code, file types and quotas; never executed), list deploys
- Capabilities
- host.deploy.create
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonhost.deploy-create-request@1- Response
application/jsonhost.deploy-create-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.deploy.create</strong> (first-party): Upload an immutable static deploy (tar/tar.gz or multipart files; validated for path traversal, links, special and hidden files, server-side code, file types and quotas; never executed), list deploys and their upload logs, activate a deploy and roll a site back to any earlier ready deploy (one atomic pointer switch). Also judged by the acting principal's project role (deployer or above); an app principal added to a project as deployer can deploy from CI. A site with a Git source also accepts a CI-built deploy at /sites/:id/source/deploys naming the ref and full commit_sha; it is always a preview and records that commit as immutable provenance.</p>GET /api/v1/deploys/{id}/log
Upload an immutable static deploy (tar/tar.gz or multipart files; validated for path traversal, links, special and hidden files, server-side code, file types and quotas; never executed), list deploys
- Capabilities
- host.deploy.create
- Visibility
- first-party
- Parameters
id(path, required)
- Input
- host.deploy-create-request@1
- Response
application/jsonhost.deploy-create-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.deploy.create</strong> (first-party): Upload an immutable static deploy (tar/tar.gz or multipart files; validated for path traversal, links, special and hidden files, server-side code, file types and quotas; never executed), list deploys and their upload logs, activate a deploy and roll a site back to any earlier ready deploy (one atomic pointer switch). Also judged by the acting principal's project role (deployer or above); an app principal added to a project as deployer can deploy from CI. A site with a Git source also accepts a CI-built deploy at /sites/:id/source/deploys naming the ref and full commit_sha; it is always a preview and records that commit as immutable provenance.</p>DELETE /api/v1/domains/{id}
Add a custom domain to a static site (never an OpenVibe domain; not in sandbox projects), read its DNS TXT verification and routing records, trigger a verification check, and remove it.
- Capabilities
- host.domain.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Input
- host.domain-manage-request@1
- Response
application/jsonhost.domain-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.domain.manage</strong> (first-party): Add a custom domain to a static site (never an OpenVibe domain; not in sandbox projects), read its DNS TXT verification and routing records, trigger a verification check, and remove it. A custom domain is served only after its TXT record is verified; TLS certificates are issued by an operator and never pass through this capability.</p>POST /api/v1/domains/{id}/verify
Add a custom domain to a static site (never an OpenVibe domain; not in sandbox projects), read its DNS TXT verification and routing records, trigger a verification check, and remove it.
- Capabilities
- host.domain.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonhost.domain-manage-request@1- Response
application/jsonhost.domain-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.domain.manage</strong> (first-party): Add a custom domain to a static site (never an OpenVibe domain; not in sandbox projects), read its DNS TXT verification and routing records, trigger a verification check, and remove it. A custom domain is served only after its TXT record is verified; TLS certificates are issued by an operator and never pass through this capability.</p>GET /api/v1/projects
Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner
- Capabilities
- host.site.manage
- Visibility
- first-party
- Input
- host.site-manage-request@1
- Response
application/jsonhost.site-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.manage</strong> (first-party): Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner role), create and delete sites, delete a deploy that is not active. Also judged by the acting principal's project role; a sandbox token (env=sandbox) is refused on production projects. Quota changes and takedowns (stop serving a site or a whole project while keeping its content for review; lift) additionally need a Network staff user. Read, set or remove a site's Git source (provider, public repository URL and branch; never a credential).</p>POST /api/v1/projects
Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner
- Capabilities
- host.site.manage
- Visibility
- first-party
- Request body
application/jsonhost.site-manage-request@1- Response
application/jsonhost.site-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.manage</strong> (first-party): Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner role), create and delete sites, delete a deploy that is not active. Also judged by the acting principal's project role; a sandbox token (env=sandbox) is refused on production projects. Quota changes and takedowns (stop serving a site or a whole project while keeping its content for review; lift) additionally need a Network staff user. Read, set or remove a site's Git source (provider, public repository URL and branch; never a credential).</p>GET /api/v1/projects/{id}
Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner
- Capabilities
- host.site.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Input
- host.site-manage-request@1
- Response
application/jsonhost.site-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.manage</strong> (first-party): Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner role), create and delete sites, delete a deploy that is not active. Also judged by the acting principal's project role; a sandbox token (env=sandbox) is refused on production projects. Quota changes and takedowns (stop serving a site or a whole project while keeping its content for review; lift) additionally need a Network staff user. Read, set or remove a site's Git source (provider, public repository URL and branch; never a credential).</p>DELETE /api/v1/projects/{id}
Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner
- Capabilities
- host.site.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Input
- host.site-manage-request@1
- Response
application/jsonhost.site-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.manage</strong> (first-party): Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner role), create and delete sites, delete a deploy that is not active. Also judged by the acting principal's project role; a sandbox token (env=sandbox) is refused on production projects. Quota changes and takedowns (stop serving a site or a whole project while keeping its content for review; lift) additionally need a Network staff user. Read, set or remove a site's Git source (provider, public repository URL and branch; never a credential).</p>PUT /api/v1/projects/{id}/members/{principal}
Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner
- Capabilities
- host.site.manage
- Visibility
- first-party
- Parameters
id(path, required)principal(path, required)
- Request body
application/jsonhost.site-manage-request@1- Response
application/jsonhost.site-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.manage</strong> (first-party): Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner role), create and delete sites, delete a deploy that is not active. Also judged by the acting principal's project role; a sandbox token (env=sandbox) is refused on production projects. Quota changes and takedowns (stop serving a site or a whole project while keeping its content for review; lift) additionally need a Network staff user. Read, set or remove a site's Git source (provider, public repository URL and branch; never a credential).</p>DELETE /api/v1/projects/{id}/members/{principal}
Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner
- Capabilities
- host.site.manage
- Visibility
- first-party
- Parameters
id(path, required)principal(path, required)
- Input
- host.site-manage-request@1
- Response
application/jsonhost.site-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.manage</strong> (first-party): Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner role), create and delete sites, delete a deploy that is not active. Also judged by the acting principal's project role; a sandbox token (env=sandbox) is refused on production projects. Quota changes and takedowns (stop serving a site or a whole project while keeping its content for review; lift) additionally need a Network staff user. Read, set or remove a site's Git source (provider, public repository URL and branch; never a credential).</p>GET /api/v1/projects/{id}/quota
Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner
- Capabilities
- host.site.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Input
- host.site-manage-request@1
- Response
application/jsonhost.site-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.manage</strong> (first-party): Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner role), create and delete sites, delete a deploy that is not active. Also judged by the acting principal's project role; a sandbox token (env=sandbox) is refused on production projects. Quota changes and takedowns (stop serving a site or a whole project while keeping its content for review; lift) additionally need a Network staff user. Read, set or remove a site's Git source (provider, public repository URL and branch; never a credential).</p>PUT /api/v1/projects/{id}/quota
Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner
- Capabilities
- host.site.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonhost.site-manage-request@1- Response
application/jsonhost.site-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.manage</strong> (first-party): Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner role), create and delete sites, delete a deploy that is not active. Also judged by the acting principal's project role; a sandbox token (env=sandbox) is refused on production projects. Quota changes and takedowns (stop serving a site or a whole project while keeping its content for review; lift) additionally need a Network staff user. Read, set or remove a site's Git source (provider, public repository URL and branch; never a credential).</p>GET /api/v1/projects/{id}/sites
Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner
- Capabilities
- host.site.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Input
- host.site-manage-request@1
- Response
application/jsonhost.site-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.manage</strong> (first-party): Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner role), create and delete sites, delete a deploy that is not active. Also judged by the acting principal's project role; a sandbox token (env=sandbox) is refused on production projects. Quota changes and takedowns (stop serving a site or a whole project while keeping its content for review; lift) additionally need a Network staff user. Read, set or remove a site's Git source (provider, public repository URL and branch; never a credential).</p>POST /api/v1/projects/{id}/sites
Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner
- Capabilities
- host.site.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonhost.site-manage-request@1- Response
application/jsonhost.site-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.manage</strong> (first-party): Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner role), create and delete sites, delete a deploy that is not active. Also judged by the acting principal's project role; a sandbox token (env=sandbox) is refused on production projects. Quota changes and takedowns (stop serving a site or a whole project while keeping its content for review; lift) additionally need a Network staff user. Read, set or remove a site's Git source (provider, public repository URL and branch; never a credential).</p>POST /api/v1/projects/{id}/takedown
Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner
- Capabilities
- host.site.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonhost.site-manage-request@1- Response
application/jsonhost.site-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.manage</strong> (first-party): Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner role), create and delete sites, delete a deploy that is not active. Also judged by the acting principal's project role; a sandbox token (env=sandbox) is refused on production projects. Quota changes and takedowns (stop serving a site or a whole project while keeping its content for review; lift) additionally need a Network staff user. Read, set or remove a site's Git source (provider, public repository URL and branch; never a credential).</p>DELETE /api/v1/projects/{id}/takedown
Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner
- Capabilities
- host.site.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Input
- host.site-manage-request@1
- Response
application/jsonhost.site-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.manage</strong> (first-party): Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner role), create and delete sites, delete a deploy that is not active. Also judged by the acting principal's project role; a sandbox token (env=sandbox) is refused on production projects. Quota changes and takedowns (stop serving a site or a whole project while keeping its content for review; lift) additionally need a Network staff user. Read, set or remove a site's Git source (provider, public repository URL and branch; never a credential).</p>GET /api/v1/resources
Read OpenVibe.Host's resource index (ADR-048): GET /api/v1/resources lists the resources Host owns as a page of common.resource-summary@1 (common.resource-list-result@1), and GET /api/v1/resources/:ov
- Capabilities
- host.resource.read
- Visibility
- first-party
- Response
application/jsoncommon.resource-list-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.resource.read</strong> (first-party): Read OpenVibe.Host's resource index (ADR-048): GET /api/v1/resources lists the resources Host owns as a page of common.resource-summary@1 (common.resource-list-result@1), and GET /api/v1/resources/:ovrn reads one by its OVRN (common.resource-summary@1). Every authority serves these for OpenVibe.Services to fan out and merge; Host's own resources are its static sites (kind host.site, id sit_<ULID>), the immutable deploys of those sites (kind host.deploy, id dpl_<ULID>) and their default and custom domains (kind host.domain, id dom_<ULID>), each with the project_id of the Network project that owns it. Host lists no projects; only Network lists projects. Planned until Host ships the index.</p>GET /api/v1/resources/{ovrn}
Read OpenVibe.Host's resource index (ADR-048): GET /api/v1/resources lists the resources Host owns as a page of common.resource-summary@1 (common.resource-list-result@1), and GET /api/v1/resources/:ov
- Capabilities
- host.resource.read
- Visibility
- first-party
- Parameters
ovrn(path, required)
- Response
application/jsoncommon.resource-list-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.resource.read</strong> (first-party): Read OpenVibe.Host's resource index (ADR-048): GET /api/v1/resources lists the resources Host owns as a page of common.resource-summary@1 (common.resource-list-result@1), and GET /api/v1/resources/:ovrn reads one by its OVRN (common.resource-summary@1). Every authority serves these for OpenVibe.Services to fan out and merge; Host's own resources are its static sites (kind host.site, id sit_<ULID>), the immutable deploys of those sites (kind host.deploy, id dpl_<ULID>) and their default and custom domains (kind host.domain, id dom_<ULID>), each with the project_id of the Network project that owns it. Host lists no projects; only Network lists projects. Planned until Host ships the index.</p>GET /api/v1/sites/{id}
Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner
- Capabilities
- host.site.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Input
- host.site-manage-request@1
- Response
application/jsonhost.site-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.manage</strong> (first-party): Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner role), create and delete sites, delete a deploy that is not active. Also judged by the acting principal's project role; a sandbox token (env=sandbox) is refused on production projects. Quota changes and takedowns (stop serving a site or a whole project while keeping its content for review; lift) additionally need a Network staff user. Read, set or remove a site's Git source (provider, public repository URL and branch; never a credential).</p>DELETE /api/v1/sites/{id}
Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner
- Capabilities
- host.site.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Input
- host.site-manage-request@1
- Response
application/jsonhost.site-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.manage</strong> (first-party): Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner role), create and delete sites, delete a deploy that is not active. Also judged by the acting principal's project role; a sandbox token (env=sandbox) is refused on production projects. Quota changes and takedowns (stop serving a site or a whole project while keeping its content for review; lift) additionally need a Network staff user. Read, set or remove a site's Git source (provider, public repository URL and branch; never a credential).</p>GET /api/v1/sites/{id}/config
Read, set and reset a Host site's serving configuration: response headers, local-only redirects and the SPA fallback (extensionless paths serve index.html).
- Capabilities
- host.site.config
- Visibility
- first-party
- Parameters
id(path, required)headers(query)redirects(query)spa(query)
- Input
- host.site-config-request@1
- Response
application/jsonhost.site-config-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.config</strong> (first-party): Read, set and reset a Host site's serving configuration: response headers, local-only redirects and the SPA fallback (extensionless paths serve index.html). A capability holder must also hold the acting principal's project role (maintainer or owner to change, any role to read). Reserved headers (Content-Security-Policy, Strict-Transport-Security, Set-Cookie, X-Forwarded-*, caching, scope, transport and the platform's own) are refused, and a redirect target must be a local path, so a site can never become an open redirect.</p>PUT /api/v1/sites/{id}/config
Read, set and reset a Host site's serving configuration: response headers, local-only redirects and the SPA fallback (extensionless paths serve index.html).
- Capabilities
- host.site.config
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonhost.site-config-request@1- Response
application/jsonhost.site-config-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.config</strong> (first-party): Read, set and reset a Host site's serving configuration: response headers, local-only redirects and the SPA fallback (extensionless paths serve index.html). A capability holder must also hold the acting principal's project role (maintainer or owner to change, any role to read). Reserved headers (Content-Security-Policy, Strict-Transport-Security, Set-Cookie, X-Forwarded-*, caching, scope, transport and the platform's own) are refused, and a redirect target must be a local path, so a site can never become an open redirect.</p>DELETE /api/v1/sites/{id}/config
Read, set and reset a Host site's serving configuration: response headers, local-only redirects and the SPA fallback (extensionless paths serve index.html).
- Capabilities
- host.site.config
- Visibility
- first-party
- Parameters
id(path, required)headers(query)redirects(query)spa(query)
- Input
- host.site-config-request@1
- Response
application/jsonhost.site-config-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.config</strong> (first-party): Read, set and reset a Host site's serving configuration: response headers, local-only redirects and the SPA fallback (extensionless paths serve index.html). A capability holder must also hold the acting principal's project role (maintainer or owner to change, any role to read). Reserved headers (Content-Security-Policy, Strict-Transport-Security, Set-Cookie, X-Forwarded-*, caching, scope, transport and the platform's own) are refused, and a redirect target must be a local path, so a site can never become an open redirect.</p>GET /api/v1/sites/{id}/deploys
Upload an immutable static deploy (tar/tar.gz or multipart files; validated for path traversal, links, special and hidden files, server-side code, file types and quotas; never executed), list deploys
- Capabilities
- host.deploy.create
- Visibility
- first-party
- Parameters
id(path, required)
- Input
- host.deploy-create-request@1
- Response
application/jsonhost.deploy-create-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.deploy.create</strong> (first-party): Upload an immutable static deploy (tar/tar.gz or multipart files; validated for path traversal, links, special and hidden files, server-side code, file types and quotas; never executed), list deploys and their upload logs, activate a deploy and roll a site back to any earlier ready deploy (one atomic pointer switch). Also judged by the acting principal's project role (deployer or above); an app principal added to a project as deployer can deploy from CI. A site with a Git source also accepts a CI-built deploy at /sites/:id/source/deploys naming the ref and full commit_sha; it is always a preview and records that commit as immutable provenance.</p>POST /api/v1/sites/{id}/deploys
Upload an immutable static deploy (tar/tar.gz or multipart files; validated for path traversal, links, special and hidden files, server-side code, file types and quotas; never executed), list deploys
- Capabilities
- host.deploy.create
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonhost.deploy-create-request@1- Response
application/jsonhost.deploy-create-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.deploy.create</strong> (first-party): Upload an immutable static deploy (tar/tar.gz or multipart files; validated for path traversal, links, special and hidden files, server-side code, file types and quotas; never executed), list deploys and their upload logs, activate a deploy and roll a site back to any earlier ready deploy (one atomic pointer switch). Also judged by the acting principal's project role (deployer or above); an app principal added to a project as deployer can deploy from CI. A site with a Git source also accepts a CI-built deploy at /sites/:id/source/deploys naming the ref and full commit_sha; it is always a preview and records that commit as immutable provenance.</p>GET /api/v1/sites/{id}/domains
Add a custom domain to a static site (never an OpenVibe domain; not in sandbox projects), read its DNS TXT verification and routing records, trigger a verification check, and remove it.
- Capabilities
- host.domain.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Input
- host.domain-manage-request@1
- Response
application/jsonhost.domain-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.domain.manage</strong> (first-party): Add a custom domain to a static site (never an OpenVibe domain; not in sandbox projects), read its DNS TXT verification and routing records, trigger a verification check, and remove it. A custom domain is served only after its TXT record is verified; TLS certificates are issued by an operator and never pass through this capability.</p>POST /api/v1/sites/{id}/domains
Add a custom domain to a static site (never an OpenVibe domain; not in sandbox projects), read its DNS TXT verification and routing records, trigger a verification check, and remove it.
- Capabilities
- host.domain.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonhost.domain-manage-request@1- Response
application/jsonhost.domain-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.domain.manage</strong> (first-party): Add a custom domain to a static site (never an OpenVibe domain; not in sandbox projects), read its DNS TXT verification and routing records, trigger a verification check, and remove it. A custom domain is served only after its TXT record is verified; TLS certificates are issued by an operator and never pass through this capability.</p>POST /api/v1/sites/{id}/rollback
Upload an immutable static deploy (tar/tar.gz or multipart files; validated for path traversal, links, special and hidden files, server-side code, file types and quotas; never executed), list deploys
- Capabilities
- host.deploy.create
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonhost.deploy-create-request@1- Response
application/jsonhost.deploy-create-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.deploy.create</strong> (first-party): Upload an immutable static deploy (tar/tar.gz or multipart files; validated for path traversal, links, special and hidden files, server-side code, file types and quotas; never executed), list deploys and their upload logs, activate a deploy and roll a site back to any earlier ready deploy (one atomic pointer switch). Also judged by the acting principal's project role (deployer or above); an app principal added to a project as deployer can deploy from CI. A site with a Git source also accepts a CI-built deploy at /sites/:id/source/deploys naming the ref and full commit_sha; it is always a preview and records that commit as immutable provenance.</p>GET /api/v1/sites/{id}/source
Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner
- Capabilities
- host.site.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Input
- host.site-manage-request@1
- Response
application/jsonhost.site-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.manage</strong> (first-party): Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner role), create and delete sites, delete a deploy that is not active. Also judged by the acting principal's project role; a sandbox token (env=sandbox) is refused on production projects. Quota changes and takedowns (stop serving a site or a whole project while keeping its content for review; lift) additionally need a Network staff user. Read, set or remove a site's Git source (provider, public repository URL and branch; never a credential).</p>PUT /api/v1/sites/{id}/source
Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner
- Capabilities
- host.site.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonhost.site-manage-request@1- Response
application/jsonhost.site-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.manage</strong> (first-party): Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner role), create and delete sites, delete a deploy that is not active. Also judged by the acting principal's project role; a sandbox token (env=sandbox) is refused on production projects. Quota changes and takedowns (stop serving a site or a whole project while keeping its content for review; lift) additionally need a Network staff user. Read, set or remove a site's Git source (provider, public repository URL and branch; never a credential).</p>DELETE /api/v1/sites/{id}/source
Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner
- Capabilities
- host.site.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Input
- host.site-manage-request@1
- Response
application/jsonhost.site-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.manage</strong> (first-party): Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner role), create and delete sites, delete a deploy that is not active. Also judged by the acting principal's project role; a sandbox token (env=sandbox) is refused on production projects. Quota changes and takedowns (stop serving a site or a whole project while keeping its content for review; lift) additionally need a Network staff user. Read, set or remove a site's Git source (provider, public repository URL and branch; never a credential).</p>POST /api/v1/sites/{id}/source/deploys
Upload an immutable static deploy (tar/tar.gz or multipart files; validated for path traversal, links, special and hidden files, server-side code, file types and quotas; never executed), list deploys
- Capabilities
- host.deploy.create
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonhost.deploy-create-request@1- Response
application/jsonhost.deploy-create-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.deploy.create</strong> (first-party): Upload an immutable static deploy (tar/tar.gz or multipart files; validated for path traversal, links, special and hidden files, server-side code, file types and quotas; never executed), list deploys and their upload logs, activate a deploy and roll a site back to any earlier ready deploy (one atomic pointer switch). Also judged by the acting principal's project role (deployer or above); an app principal added to a project as deployer can deploy from CI. A site with a Git source also accepts a CI-built deploy at /sites/:id/source/deploys naming the ref and full commit_sha; it is always a preview and records that commit as immutable provenance.</p>POST /api/v1/sites/{id}/takedown
Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner
- Capabilities
- host.site.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonhost.site-manage-request@1- Response
application/jsonhost.site-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>host.site.manage</strong> (first-party): Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner role), create and delete sites, delete a deploy that is not active. Also judged by the acting principal's project role; a sandbox token (env=sandbox) is refused on production projects. Quota changes and takedowns (stop serving a site or a whole project while keeping its content for review; lift) additionally need a Network staff user. Read, set or remove a site's Git source (provider, public repository URL and branch; never a credential).</p>DELETE /api/v1/sites/{id}/takedown
Manage OpenVibe.Host tenant projects and static sites: create a project (owned by the person named with X-OV-Subject; apps cannot own projects), read projects, quotas and usage, manage members (owner
- Capabilities
- host.site.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Input
- host.site-manage-request@1
- Response
application/jsonhost.site-manage-result@1- Errors
- errors.problem@1 (application/problem+json)