Create a Volume
const url = 'https://example.com/apis/nodus.dev/v1/namespaces/example/volumes';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"apiVersion":"example","kind":"example","metadata":{"annotations":{"additionalProperty":"example"},"creationTimestamp":"example","deletionGracePeriodSeconds":1,"deletionTimestamp":"example","finalizers":["example"],"generateName":"example","generation":1,"labels":{"additionalProperty":"example"},"managedFields":[{"apiVersion":"example","fieldsType":"example","fieldsV1":{"additionalProperty":"example"},"manager":"example","operation":"example","subresource":"example","time":"example"}],"name":"example","namespace":"example","ownerReferences":[{"apiVersion":"example","blockOwnerDeletion":true,"controller":true,"kind":"example","name":"example","uid":"example"}],"resourceVersion":"example","selfLink":"example","uid":"example"},"spec":{"accessMode":"example","commitInterval":"example","maxCostUSD":"example","revisionHistoryLimit":1,"size":"example","source":{"connectionQuery":{"connection":"example","format":"example","sql":"example"},"git":{"lfs":true,"ref":"example","repo":"example"},"huggingface":{"files":["example"],"repo":"example","revision":"example","secret":"example"},"s3":{"connection":"example","uri":"example"},"upload":{},"url":{"extract":"example","sha256":"example","url":"example"}},"ttlAfterUnused":"example"},"status":{"conditions":[{"lastTransitionTime":"example","message":"example","observedGeneration":1,"reason":"example","status":"example","type":"example"}],"holder":{"attempt":"example","epoch":1,"kind":"example","name":"example"},"import":{"attempt":"example","bytes":1,"completionTime":"example","files":1,"generation":1,"sha256":"example","startTime":"example"},"lastCommitTime":"example","message":"example","observedGeneration":1,"phase":"example","readers":1,"reason":"example","revision":1,"storage":{"billedBytes":1,"bytes":1},"used":"example"}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/apis/nodus.dev/v1/namespaces/example/volumes \ --header 'Content-Type: application/json' \ --data '{ "apiVersion": "example", "kind": "example", "metadata": { "annotations": { "additionalProperty": "example" }, "creationTimestamp": "example", "deletionGracePeriodSeconds": 1, "deletionTimestamp": "example", "finalizers": [ "example" ], "generateName": "example", "generation": 1, "labels": { "additionalProperty": "example" }, "managedFields": [ { "apiVersion": "example", "fieldsType": "example", "fieldsV1": { "additionalProperty": "example" }, "manager": "example", "operation": "example", "subresource": "example", "time": "example" } ], "name": "example", "namespace": "example", "ownerReferences": [ { "apiVersion": "example", "blockOwnerDeletion": true, "controller": true, "kind": "example", "name": "example", "uid": "example" } ], "resourceVersion": "example", "selfLink": "example", "uid": "example" }, "spec": { "accessMode": "example", "commitInterval": "example", "maxCostUSD": "example", "revisionHistoryLimit": 1, "size": "example", "source": { "connectionQuery": { "connection": "example", "format": "example", "sql": "example" }, "git": { "lfs": true, "ref": "example", "repo": "example" }, "huggingface": { "files": [ "example" ], "repo": "example", "revision": "example", "secret": "example" }, "s3": { "connection": "example", "uri": "example" }, "upload": {}, "url": { "extract": "example", "sha256": "example", "url": "example" } }, "ttlAfterUnused": "example" }, "status": { "conditions": [ { "lastTransitionTime": "example", "message": "example", "observedGeneration": 1, "reason": "example", "status": "example", "type": "example" } ], "holder": { "attempt": "example", "epoch": 1, "kind": "example", "name": "example" }, "import": { "attempt": "example", "bytes": 1, "completionTime": "example", "files": 1, "generation": 1, "sha256": "example", "startTime": "example" }, "lastCommitTime": "example", "message": "example", "observedGeneration": 1, "phase": "example", "readers": 1, "reason": "example", "revision": 1, "storage": { "billedBytes": 1, "bytes": 1 }, "used": "example" } }'Parameters
Section titled “ Parameters ”Path Parameters
Section titled “ Path Parameters ”The project.
Query Parameters
Section titled “ Query Parameters ”Header Parameters
Section titled “ Header Parameters ”Request Bodyrequired
Section titled “ Request Bodyrequired ”Volume is named storage backed by immutable revisions in the Volume’s own repository: ReadWriteOnce (one writer under a lease), ReadOnlyMany (the latest Ready revision) or ReadWriteMany (each attempt commits its changed paths as a new revision, last writer wins per path).
object
object
object
object
object
object
object
VolumeSpec is a Volume’s shape.
object
AccessMode is ReadWriteOnce, ReadOnlyMany or ReadWriteMany; immutable.
CommitInterval is how often a ReadWriteOnce or ReadWriteMany mount commits (1m–1h).
MaxCostUSD caps import and export attempts.
RevisionHistoryLimit is how many revisions are kept (1–100).
Size caps the logical bytes of a revision; storage is billed on use.
VolumeSource is exactly one import source.
object
ConnectionQuerySource is a SQL query exported through a Postgres-type Connection.
object
Connection names the Connection.
Format is Parquet or CSV.
SQL is the read-only query.
VolumeGitSource is a git repository.
object
LFS fetches LFS objects.
Ref is a branch, tag or commit.
Repo is the https clone URL.
HuggingFaceSource is a Hugging Face repository.
object
Files are globs limiting the download.
Repo is owner/name.
Revision is a 40-hex commit or a tag resolved at admission.
Secret holds HF_TOKEN for gated repositories.
S3Source is a bucket prefix read through an S3 Connection.
object
Connection names the S3 Connection.
URI is s3://bucket/prefix.
VolumeUploadSource marks an upload-filled Volume.
object
URLSource is one https file.
object
Extract is Auto (unpack zip and tar archives) or None.
SHA256 is the expected hex digest.
URL is the https address.
TTLAfterUnused deletes the Volume this long after its last mount or upload.
VolumeStatus is the latest revision and usage.
object
Conditions are the latest observations.
object
VolumeHolder is a ReadWriteOnce Volume’s writer.
object
Attempt is the attempt id.
Epoch is the attempt’s fencing epoch.
Kind and Name are the owning object.
Name is the owning object’s name.
VolumeImport describes an import.
object
Attempt is the internal attempt running the import.
Bytes is how much the import has written so far.
CompletionTime is when the import finished.
Files is how many files the import has written so far.
Generation is the spec generation the import is for; a spec change starts a new import.
SHA256 is the digest of the downloaded source, once known.
StartTime is when the import started.
LastCommitTime is the latest revision’s commit time.
Message is a scrubbed explanation.
ObservedGeneration is the spec generation the status reflects.
Phase is Pending while creating or importing, Ready or Failed.
Readers is the number of attempts mounting it read-only.
Reason says why the Volume failed, for example ImportFailed.
Revision is the latest committed revision.
VolumeStorage is the repository’s physical size.
object
BilledBytes is the part billed after the org’s inclusion.
Bytes are all kept revisions, deduplicated and compressed.
Used is the logical size of the latest revision.
Example generated
{ "apiVersion": "example", "kind": "example", "metadata": { "annotations": { "additionalProperty": "example" }, "creationTimestamp": "example", "deletionGracePeriodSeconds": 1, "deletionTimestamp": "example", "finalizers": [ "example" ], "generateName": "example", "generation": 1, "labels": { "additionalProperty": "example" }, "managedFields": [ { "apiVersion": "example", "fieldsType": "example", "fieldsV1": { "additionalProperty": "example" }, "manager": "example", "operation": "example", "subresource": "example", "time": "example" } ], "name": "example", "namespace": "example", "ownerReferences": [ { "apiVersion": "example", "blockOwnerDeletion": true, "controller": true, "kind": "example", "name": "example", "uid": "example" } ], "resourceVersion": "example", "selfLink": "example", "uid": "example" }, "spec": { "accessMode": "example", "commitInterval": "example", "maxCostUSD": "example", "revisionHistoryLimit": 1, "size": "example", "source": { "connectionQuery": { "connection": "example", "format": "example", "sql": "example" }, "git": { "lfs": true, "ref": "example", "repo": "example" }, "huggingface": { "files": [ "example" ], "repo": "example", "revision": "example", "secret": "example" }, "s3": { "connection": "example", "uri": "example" }, "upload": {}, "url": { "extract": "example", "sha256": "example", "url": "example" } }, "ttlAfterUnused": "example" }, "status": { "conditions": [ { "lastTransitionTime": "example", "message": "example", "observedGeneration": 1, "reason": "example", "status": "example", "type": "example" } ], "holder": { "attempt": "example", "epoch": 1, "kind": "example", "name": "example" }, "import": { "attempt": "example", "bytes": 1, "completionTime": "example", "files": 1, "generation": 1, "sha256": "example", "startTime": "example" }, "lastCommitTime": "example", "message": "example", "observedGeneration": 1, "phase": "example", "readers": 1, "reason": "example", "revision": 1, "storage": { "billedBytes": 1, "bytes": 1 }, "used": "example" }}Responses
Section titled “ Responses ”OK
Volume is named storage backed by immutable revisions in the Volume’s own repository: ReadWriteOnce (one writer under a lease), ReadOnlyMany (the latest Ready revision) or ReadWriteMany (each attempt commits its changed paths as a new revision, last writer wins per path).
object
object
object
object
object
object
object
VolumeSpec is a Volume’s shape.
object
AccessMode is ReadWriteOnce, ReadOnlyMany or ReadWriteMany; immutable.
CommitInterval is how often a ReadWriteOnce or ReadWriteMany mount commits (1m–1h).
MaxCostUSD caps import and export attempts.
RevisionHistoryLimit is how many revisions are kept (1–100).
Size caps the logical bytes of a revision; storage is billed on use.
VolumeSource is exactly one import source.
object
ConnectionQuerySource is a SQL query exported through a Postgres-type Connection.
object
Connection names the Connection.
Format is Parquet or CSV.
SQL is the read-only query.
VolumeGitSource is a git repository.
object
LFS fetches LFS objects.
Ref is a branch, tag or commit.
Repo is the https clone URL.
HuggingFaceSource is a Hugging Face repository.
object
Files are globs limiting the download.
Repo is owner/name.
Revision is a 40-hex commit or a tag resolved at admission.
Secret holds HF_TOKEN for gated repositories.
S3Source is a bucket prefix read through an S3 Connection.
object
Connection names the S3 Connection.
URI is s3://bucket/prefix.
VolumeUploadSource marks an upload-filled Volume.
object
URLSource is one https file.
object
Extract is Auto (unpack zip and tar archives) or None.
SHA256 is the expected hex digest.
URL is the https address.
TTLAfterUnused deletes the Volume this long after its last mount or upload.
VolumeStatus is the latest revision and usage.
object
Conditions are the latest observations.
object
VolumeHolder is a ReadWriteOnce Volume’s writer.
object
Attempt is the attempt id.
Epoch is the attempt’s fencing epoch.
Kind and Name are the owning object.
Name is the owning object’s name.
VolumeImport describes an import.
object
Attempt is the internal attempt running the import.
Bytes is how much the import has written so far.
CompletionTime is when the import finished.
Files is how many files the import has written so far.
Generation is the spec generation the import is for; a spec change starts a new import.
SHA256 is the digest of the downloaded source, once known.
StartTime is when the import started.
LastCommitTime is the latest revision’s commit time.
Message is a scrubbed explanation.
ObservedGeneration is the spec generation the status reflects.
Phase is Pending while creating or importing, Ready or Failed.
Readers is the number of attempts mounting it read-only.
Reason says why the Volume failed, for example ImportFailed.
Revision is the latest committed revision.
VolumeStorage is the repository’s physical size.
object
BilledBytes is the part billed after the org’s inclusion.
Bytes are all kept revisions, deduplicated and compressed.
Used is the logical size of the latest revision.
Example generated
{ "apiVersion": "example", "kind": "example", "metadata": { "annotations": { "additionalProperty": "example" }, "creationTimestamp": "example", "deletionGracePeriodSeconds": 1, "deletionTimestamp": "example", "finalizers": [ "example" ], "generateName": "example", "generation": 1, "labels": { "additionalProperty": "example" }, "managedFields": [ { "apiVersion": "example", "fieldsType": "example", "fieldsV1": { "additionalProperty": "example" }, "manager": "example", "operation": "example", "subresource": "example", "time": "example" } ], "name": "example", "namespace": "example", "ownerReferences": [ { "apiVersion": "example", "blockOwnerDeletion": true, "controller": true, "kind": "example", "name": "example", "uid": "example" } ], "resourceVersion": "example", "selfLink": "example", "uid": "example" }, "spec": { "accessMode": "example", "commitInterval": "example", "maxCostUSD": "example", "revisionHistoryLimit": 1, "size": "example", "source": { "connectionQuery": { "connection": "example", "format": "example", "sql": "example" }, "git": { "lfs": true, "ref": "example", "repo": "example" }, "huggingface": { "files": [ "example" ], "repo": "example", "revision": "example", "secret": "example" }, "s3": { "connection": "example", "uri": "example" }, "upload": {}, "url": { "extract": "example", "sha256": "example", "url": "example" } }, "ttlAfterUnused": "example" }, "status": { "conditions": [ { "lastTransitionTime": "example", "message": "example", "observedGeneration": 1, "reason": "example", "status": "example", "type": "example" } ], "holder": { "attempt": "example", "epoch": 1, "kind": "example", "name": "example" }, "import": { "attempt": "example", "bytes": 1, "completionTime": "example", "files": 1, "generation": 1, "sha256": "example", "startTime": "example" }, "lastCommitTime": "example", "message": "example", "observedGeneration": 1, "phase": "example", "readers": 1, "reason": "example", "revision": 1, "storage": { "billedBytes": 1, "bytes": 1 }, "used": "example" }}default
Section titled “ default ”An error: a metav1.Status whose reason is a registered code.
Status is the error body of every API response: a Kubernetes metav1.Status (so kubectl and client-go understand it) plus three top-level extensions that those clients ignore (ADR-028).
object
object
object
Docs is the URL of the code’s docs page.
Fix says what to do next, for example a CLI command or the field to change.
object
object
RequestID identifies the request in logs and support tickets.
Example generated
{ "apiVersion": "example", "code": 1, "details": { "causes": [ { "field": "example", "message": "example", "reason": "example" } ], "group": "example", "kind": "example", "name": "example", "retryAfterSeconds": 1, "uid": "example" }, "docs": "example", "fix": "example", "kind": "example", "message": "example", "metadata": { "continue": "example", "remainingItemCount": 1, "resourceVersion": "example", "selfLink": "example", "shardInfo": { "selector": "example" } }, "reason": "example", "requestId": "example", "status": "example"}