API Reference
Metadata
Attach custom key-value metadata to your workspace. Use metadata for tagging, categorization, or storing application-specific data.
Get metadata
Get all metadata for a workspace.
const metadata = await ws.metadata.get('ws_a1b2c3d4');
console.log(metadata);
// { environment: "production", owner: "team-a", git_sha: "abc123" }GET /workspace/:workspaceId/metadatacurl "https://api.oblien.com/workspace/ws_a1b2c3d4/metadata" \
-H "X-Client-ID: $OBLIEN_CLIENT_ID" \
-H "X-Client-Secret: $OBLIEN_CLIENT_SECRET"Update
Set or update metadata fields. Existing keys are overwritten, new keys are added.
await ws.metadata.update('ws_a1b2c3d4', {
metadata: {
environment: 'staging',
owner: 'team-a',
git_sha: 'def456',
deployed_at: new Date().toISOString(),
},
});PUT /workspace/:workspaceId/metadata{
"metadata": {
"environment": "staging",
"owner": "team-a",
"git_sha": "def456",
"deployed_at": "2026-02-24T10:30:00Z"
}
}Also supports PATCH method.
curl -X PUT "https://api.oblien.com/workspace/ws_a1b2c3d4/metadata" \
-H "X-Client-ID: $OBLIEN_CLIENT_ID" \
-H "X-Client-Secret: $OBLIEN_CLIENT_SECRET" \
-H "Content-Type: application/json" \
-d '{
"metadata": {
"environment": "staging",
"git_sha": "def456"
}
}'Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
metadata | object | Yes | Key-value pairs. Values can be any JSON type |
The metadata field must be a valid object. Keys and values are stored as-is.