KV namespaces
A KvNamespace is one managed key-value store: versioned bytes with compare-and-set, TTL, prefix list, and a supported command profile.
A KvNamespace is one managed key-value store: versioned bytes with compare-and-set, TTL, prefix list, and a supported command profile. Silo: each has its own credentials, backup, region, and deletion.
Service Sylphx Data · Resource type data.sylphx.com/KvNamespace · Name pattern orgs/{org}/projects/{project}/envs/{env}/kv_namespaces/{kv_namespace} · Shape spec_status
Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/kv_namespaces/{kv_namespace}. |
uid | string | kv_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | KvNamespaceSpec | Desired state. Required. |
status | KvNamespaceStatus | Observed state. Output only. |
Methods
Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets a kv namespace. |
GET | list | Lists kv namespaces in a environment. |
POST | create | Creates a kv namespace. The Operation is done when the controller settles it. |
PATCH | update | Updates a kv namespace. |
DELETE | delete | Deletes a kv namespace. Fails while spec.deletion_protection is set. |
POST | connect | Returns how to connect to the KV namespace: its endpoint and its own engine credentials. The credentials are not API keys and are returned only here. |
POST | rotate_credentials | Replaces the KV namespace's engine credentials; the old ones stop working once the new ones are served. |
get
Gets a kv namespace.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/kv_namespaces/kv-namespace · scope data:read · effect read · Request, response and examples
list
Lists kv namespaces in a environment.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/kv_namespaces · scope data:read · effect read · paginated · Request, response and examples
create
Creates a kv namespace. The Operation is done when the controller settles it.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/kv_namespaces · scope data:write · effect write · long-running · Request, response and examples
update
Updates a kv namespace.
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/kv_namespaces/kv-namespace · scope data:write · effect write · long-running · Request, response and examples
delete
Deletes a kv namespace. Fails while spec.deletion_protection is set.
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/kv_namespaces/kv-namespace · scope data:write · effect destructive · long-running · Request, response and examples
connect
Returns how to connect to the KV namespace: its endpoint and its own engine credentials. The credentials are not API keys and are returned only here.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/kv_namespaces/kv-namespace:connect · scope data:write · effect read · Request, response and examples
rotate_credentials
Replaces the KV namespace's engine credentials; the old ones stop working once the new ones are served.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/kv_namespaces/kv-namespace:rotateCredentials · scope data:write · effect write · validate_only · long-running · Request, response and examples