Workspaces APIs

Introduced 2.18

The Workspaces API provides a set of endpoints for managing workspaces in OpenSearch Dashboards.

List Workspaces API

You can use the following endpoint to retrieve a list of workspaces:

POST <osd host>:<port>/api/workspaces/_list

copy

The following table lists the available path parameters.

Example request

POST /api/workspaces/_list

copy

The following example response shows a successful API call:

{
    "success": true,
    "result": {
        "page": 1,
        "per_page": 20,
        "total": 3,
        "workspaces": [
            {
                "name": "test1",
                "features": [
                    "use-case-all"
                ],
                "id": "hWNZls"
            },
            {
                "name": "test2",
                "features": [
                    "use-case-observability"
                ],
                "id": "SnkOPt"
            }
        ]
    }
}

copy

Get Workspaces API

You can use the following endpoint to retrieve a single workspace:

GET <osd host>:<port>/api/workspaces/<id>

copy

The following table lists the available path parameters. All path parameters are required.

Example request

GET /api/workspaces/SnkOPt

copy

The following example response shows a successful API call:

{
    "success": true,
    "result": {
        "name": "test2",
        "features": ["use-case-all"],
        "id": "SnkOPt"
    }
}

copy

Create Workspaces API

You can use the following endpoint to create a workspace:

POST <osd host>:<port>/api/workspaces

copy

The following table lists the available path parameters.

Example request

POST api/workspaces
{
    "attributes": {
        "name": "test4",
        "description": "test4"
    }
}

copy

The following example response shows a successful API call:

{
    "success": true,
    "result": {
        "id": "eHVoCJ"
    }
}

copy

Update Workspaces API

You can use the following endpoint to update the attributes and permissions for a workspace:

PUT <osd host>:<port>/api/workspaces/<id>

copy

The following table lists the available path parameters.

Example request

PUT api/workspaces/eHVoCJ
{
    "attributes": {
        "name": "test4",
        "description": "test update"
    }
}

copy

The following example response shows a successful API call:

{
    "success": true,
    "result": true
}

copy

Delete Workspaces API

You can use the following endpoint to delete a workspace:

DELETE <osd host>:<port>/api/workspaces/<id>

copy

The following table lists the available path parameters. All path parameters are required.

Example request

DELETE api/workspaces/eHVoCJ

copy

The following example response shows a successful API call:

{
    "success": true,
    "result": true
}

copy

Duplicate Saved Objects Workspaces API

You can use the following endpoint to copy saved objects between workspaces:

POST <osd host>:<port>/api/workspaces/_duplicate_saved_objects

copy

The following table lists the available path parameters.

The following table lists the attributes of the object in the objects parameter.

Example request

POST api/workspaces/_duplicate_saved_objects
{
    "objects": [
        {
            "type": "index-pattern",
            "id": "619cc200-ecd0-11ee-95b1-e7363f9e289d"
        }
    ],
    "targetWorkspace": "9gt4lB"
}

copy

The following example response shows a successful API call:

{
    "successCount": 1,
    "success": true,
    "successResults": [
        {
            "type": "index-pattern",
            "id": "619cc200-ecd0-11ee-95b1-e7363f9e289d",
            "meta": {
                "title": "test*",
                "icon": "indexPatternApp"
            },
            "destinationId": "f4b724fd-9647-4bbf-bf59-610b43a62c75"
        }
    ]
}

copy

Associate Saved Objects Workspaces API

You can use the following endpoint to associate saved objects with a workspace:

POST <osd host>:<port>/api/workspaces/_associate

copy

The following table lists the available path parameters.

The following table lists the attributes of the object in the objects parameter.

Example request

POST api/workspaces/_associate
{
    "objects": [
        {
            "type": "index-pattern",
            "id": "619cc200-ecd0-11ee-95b1-e7363f9e289d"
        }
    ],
    "targetWorkspace": "9gt4lB"
}

copy

The following example response shows a successful API call:

{
    "success": true,
    "result": [
        {
            "id": "619cc200-ecd0-11ee-95b1-e7363f9e289d",
        }
    ]
}

copy

Dissociate Saved Objects Workspaces API

You can use the following endpoint to dissociate saved objects from a workspace:

POST <osd host>:<port>/api/workspaces/_dissociate

copy

The following table lists the available path parameters.

The following table lists the attributes of the savedObjects parameter.

Example request

POST api/workspaces/_dissociate
{
    "objects": [
        {
            "type": "index-pattern",
            "id": "619cc200-ecd0-11ee-95b1-e7363f9e289d"
        }
    ],
    "targetWorkspace": "9gt4lB"
}

copy

The following example response shows a successful API call:

{
    "success": true,
    "result": [
        {
            "id": "619cc200-ecd0-11ee-95b1-e7363f9e289d",
        }
    ]
}

copy