OpenVibe Connect API
Generated at from
openvibe-contracts v0.419.0 and
openvibe-sdk v0.161.0.
Server https://connect.openvibe.link. 6 routes performing 1 capabilities. OpenAPI 3.1 document.
GET /internal/config
Manage the configuration namespaces and secrets of OpenVibe Connect through openvibe-shared/config (D11), so the owner can give its keys and accounts on Network's Setup tab: GET /internal/config lists
- Capabilities
- connect.config.manage
- Visibility
- internal
- Parameters
values(query, required) — The new values, one member per key. The store validates them against the namespace schema; a secret-class value here is refused.reason(query, required) — Why the change is made; it is the revision's reason in the history.merge(query) — Merge into the active values instead of replacing them.unset(query) — Keys to remove from the new revision.
- Input
- common.config-change@1
- Response
application/jsoncommon.config-namespace@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>connect.config.manage</strong> (internal): Manage the configuration namespaces and secrets of OpenVibe Connect through openvibe-shared/config (D11), so the owner can give its keys and accounts on Network's Setup tab: GET /internal/config lists the namespace summaries, GET /internal/config/:namespace returns one as common.config-namespace@1, POST applies common.config-change@1, and PUT /internal/config/:namespace/secrets/:key sets a secret with common.config-secret-put@1 (write-only; the answer is the marker) while DELETE removes it. POST /internal/config/:namespace/test/:key asks the service's tester to try a stored value with the provider on the server, answering { ok, message } in one line that never carries a secret (the owner's Setup tab). Only Network's admin proxy, acting for the owner, holds this capability; it is never grantable to apps. Each request carries the owner as actor, and the service audits every write with that actor and key, never a secret value.</p>GET /internal/config/{namespace}
Manage the configuration namespaces and secrets of OpenVibe Connect through openvibe-shared/config (D11), so the owner can give its keys and accounts on Network's Setup tab: GET /internal/config lists
- Capabilities
- connect.config.manage
- Visibility
- internal
- Parameters
namespace(path, required)values(query, required) — The new values, one member per key. The store validates them against the namespace schema; a secret-class value here is refused.reason(query, required) — Why the change is made; it is the revision's reason in the history.merge(query) — Merge into the active values instead of replacing them.unset(query) — Keys to remove from the new revision.
- Input
- common.config-change@1
- Response
application/jsoncommon.config-namespace@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>connect.config.manage</strong> (internal): Manage the configuration namespaces and secrets of OpenVibe Connect through openvibe-shared/config (D11), so the owner can give its keys and accounts on Network's Setup tab: GET /internal/config lists the namespace summaries, GET /internal/config/:namespace returns one as common.config-namespace@1, POST applies common.config-change@1, and PUT /internal/config/:namespace/secrets/:key sets a secret with common.config-secret-put@1 (write-only; the answer is the marker) while DELETE removes it. POST /internal/config/:namespace/test/:key asks the service's tester to try a stored value with the provider on the server, answering { ok, message } in one line that never carries a secret (the owner's Setup tab). Only Network's admin proxy, acting for the owner, holds this capability; it is never grantable to apps. Each request carries the owner as actor, and the service audits every write with that actor and key, never a secret value.</p>POST /internal/config/{namespace}
Manage the configuration namespaces and secrets of OpenVibe Connect through openvibe-shared/config (D11), so the owner can give its keys and accounts on Network's Setup tab: GET /internal/config lists
- Capabilities
- connect.config.manage
- Visibility
- internal
- Parameters
namespace(path, required)
- Request body
application/jsoncommon.config-change@1- Response
application/jsoncommon.config-namespace@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>connect.config.manage</strong> (internal): Manage the configuration namespaces and secrets of OpenVibe Connect through openvibe-shared/config (D11), so the owner can give its keys and accounts on Network's Setup tab: GET /internal/config lists the namespace summaries, GET /internal/config/:namespace returns one as common.config-namespace@1, POST applies common.config-change@1, and PUT /internal/config/:namespace/secrets/:key sets a secret with common.config-secret-put@1 (write-only; the answer is the marker) while DELETE removes it. POST /internal/config/:namespace/test/:key asks the service's tester to try a stored value with the provider on the server, answering { ok, message } in one line that never carries a secret (the owner's Setup tab). Only Network's admin proxy, acting for the owner, holds this capability; it is never grantable to apps. Each request carries the owner as actor, and the service audits every write with that actor and key, never a secret value.</p>PUT /internal/config/{namespace}/secrets/{key}
Manage the configuration namespaces and secrets of OpenVibe Connect through openvibe-shared/config (D11), so the owner can give its keys and accounts on Network's Setup tab: GET /internal/config lists
- Capabilities
- connect.config.manage
- Visibility
- internal
- Parameters
namespace(path, required)key(path, required)
- Request body
application/jsoncommon.config-change@1- Response
application/jsoncommon.config-namespace@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>connect.config.manage</strong> (internal): Manage the configuration namespaces and secrets of OpenVibe Connect through openvibe-shared/config (D11), so the owner can give its keys and accounts on Network's Setup tab: GET /internal/config lists the namespace summaries, GET /internal/config/:namespace returns one as common.config-namespace@1, POST applies common.config-change@1, and PUT /internal/config/:namespace/secrets/:key sets a secret with common.config-secret-put@1 (write-only; the answer is the marker) while DELETE removes it. POST /internal/config/:namespace/test/:key asks the service's tester to try a stored value with the provider on the server, answering { ok, message } in one line that never carries a secret (the owner's Setup tab). Only Network's admin proxy, acting for the owner, holds this capability; it is never grantable to apps. Each request carries the owner as actor, and the service audits every write with that actor and key, never a secret value.</p>DELETE /internal/config/{namespace}/secrets/{key}
Manage the configuration namespaces and secrets of OpenVibe Connect through openvibe-shared/config (D11), so the owner can give its keys and accounts on Network's Setup tab: GET /internal/config lists
- Capabilities
- connect.config.manage
- Visibility
- internal
- Parameters
namespace(path, required)key(path, required)values(query, required) — The new values, one member per key. The store validates them against the namespace schema; a secret-class value here is refused.reason(query, required) — Why the change is made; it is the revision's reason in the history.merge(query) — Merge into the active values instead of replacing them.unset(query) — Keys to remove from the new revision.
- Input
- common.config-change@1
- Response
application/jsoncommon.config-namespace@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>connect.config.manage</strong> (internal): Manage the configuration namespaces and secrets of OpenVibe Connect through openvibe-shared/config (D11), so the owner can give its keys and accounts on Network's Setup tab: GET /internal/config lists the namespace summaries, GET /internal/config/:namespace returns one as common.config-namespace@1, POST applies common.config-change@1, and PUT /internal/config/:namespace/secrets/:key sets a secret with common.config-secret-put@1 (write-only; the answer is the marker) while DELETE removes it. POST /internal/config/:namespace/test/:key asks the service's tester to try a stored value with the provider on the server, answering { ok, message } in one line that never carries a secret (the owner's Setup tab). Only Network's admin proxy, acting for the owner, holds this capability; it is never grantable to apps. Each request carries the owner as actor, and the service audits every write with that actor and key, never a secret value.</p>POST /internal/config/{namespace}/test/{key}
Manage the configuration namespaces and secrets of OpenVibe Connect through openvibe-shared/config (D11), so the owner can give its keys and accounts on Network's Setup tab: GET /internal/config lists
- Capabilities
- connect.config.manage
- Visibility
- internal
- Parameters
namespace(path, required)key(path, required)
- Request body
application/jsoncommon.config-change@1- Response
application/jsoncommon.config-namespace@1- Errors
- errors.problem@1 (application/problem+json)