Workspace settings
https://api.xata.io/workspaces/workspace_id/settings
Access and update workspace settings
Expected parameters
Name | Description | In | Required | Schema |
---|---|---|---|---|
workspace_id | Workspace ID | path | ✅ | string |
Get Workspace Settings
GEThttps://api.xata.io/workspaces/workspace_id/settings
Retrieve workspace settings from a workspace ID
Responses
type GetWorkspaceSettings = {
dedicatedClusters: boolean;
};
type GetWorkspaceSettings = {
id?: string;
message: string;
};
{
"message": "invalid API key"
}
{
"message": "invalid API key"
}
type GetWorkspaceSettings = {
id?: string;
message: string;
};
type GetWorkspaceSettings = void;
Update Workspace Settings
PATCHhttps://api.xata.io/workspaces/workspace_id/settings
Update workspace settings
Request Body Type Definition
type UpdateWorkspaceSettings = Record<string, any>;
/**
* Xata Table Record Metadata
*/
type Record = RecordMeta & {
[key: string]: any;
};
/**
* Xata Table Record Metadata
*/
type RecordMeta = {
id: RecordID;
xata: {
/**
* The record's version. Can be used for optimistic concurrency control.
*/
version: number;
/**
* The time when the record was created.
*/
createdAt?: string;
/**
* The time when the record was last updated.
*/
updatedAt?: string;
/**
* The record's table name. APIs that return records from multiple tables will set this field accordingly.
*/
table?: string;
/**
* Highlights of the record. This is used by the search APIs to indicate which fields and parts of the fields have matched the search.
*/
highlight?: {
[key: string]: string[] | {
[key: string]: any;
};
};
/**
* The record's relevancy score. This is returned by the search APIs.
*/
score?: number;
/**
* Encoding/Decoding errors
*/
warnings?: string[];
};
} | {
xata_id: RecordID;
/**
* The record's version. Can be used for optimistic concurrency control.
*/
xata_version: number;
/**
* The time when the record was created.
*/
xata_createdat?: string;
/**
* The time when the record was last updated.
*/
xata_updatedat?: string;
/**
* The record's table name. APIs that return records from multiple tables will set this field accordingly.
*/
xata_table?: string;
/**
* Highlights of the record. This is used by the search APIs to indicate which fields and parts of the fields have matched the search.
*/
xata_highlight?: {
[key: string]: string[] | {
[key: string]: any;
};
};
/**
* The record's relevancy score. This is returned by the search APIs.
*/
xata_score?: number;
/**
* Encoding/Decoding errors
*/
xata_warnings?: string[];
};
/**
* @maxLength 255
* @minLength 1
* @pattern [a-zA-Z0-9_-~:]+
*/
type RecordID = string;
Responses
type UpdateWorkspaceSettings = {
dedicatedClusters: boolean;
};
type UpdateWorkspaceSettings = {
id?: string;
message: string;
};
{
"message": "invalid API key"
}
{
"message": "invalid API key"
}
type UpdateWorkspaceSettings = {
id?: string;
message: string;
};
type UpdateWorkspaceSettings = void;