Copy saved objects between spaces

Server: https://{kibana_url}

POST /api/spaces/_copy_saved_objects

It also allows you to automatically copy related objects, so when you copy a dashboard, this can automatically copy over the associated visualizations, data views, and saved Discover sessions, as required. You can request to overwrite any objects that already exist in the target space if they share an identifier or you can use the resolve copy saved objects conflicts API to do this on a per-object basis.

[Required authorization] Route required privileges: copySavedObjectsToSpaces.

Request

Response

200

OK: A successful request.

application/json

Examples

Copy a dashboard with the my-dashboard ID, including all references from the default space to the marketing space. In this example, the dashboard has a reference to a visualization and that has a reference to a data view.

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/spaces/_copy_saved_objects
{
  "objects": [
    {
      "type": "dashboard",
      "id": "my-dashboard"
    }
  ],
  "spaces": [
    "marketing"
  ],
  "includeReferences": true
}

curl Shell

curl -X POST "https://{kibana_url}/api/spaces/_copy_saved_objects" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "objects": [
    {
      "type": "dashboard",
      "id": "my-dashboard"
    }
  ],
  "spaces": [
    "marketing"
  ],
  "includeReferences": true
}'

Response

{
  "marketing": {
    "success": true,
    "successCount": 3,
    "successResults": [
      {
        "id": "my-dashboard",
        "type": "dashboard",
        "destinationId": "1e127098-5b80-417f-b0f1-c60c8395358f",
        "meta": {
          "icon": "dashboardApp",
          "title": "Look at my dashboard"
        }
      },
      {
        "id": "my-vis",
        "type": "visualization",
        "destinationId": "a610ed80-1c73-4507-9e13-d3af736c8e04",
        "meta": {
          "icon": "visualizeApp",
          "title": "Look at my visualization"
        }
      },
      {
        "id": "my-index-pattern",
        "type": "index-pattern",
        "destinationId": "bc3c9c70-bf6f-4bec-b4ce-f4189aa9e26b",
        "meta": {
          "icon": "indexPatternApp",
          "title": "my-pattern-*"
        }
      }
    ]
  }
}

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/spaces/_copy_saved_objects
{
  "objects": [
    {
      "type": "dashboard",
      "id": "my-dashboard"
    }
  ],
  "spaces": [
    "marketing"
  ],
  "includeReferences": true,
  "createNewCopies": false
}

curl Shell

curl -X POST "https://{kibana_url}/api/spaces/_copy_saved_objects" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "objects": [
    {
      "type": "dashboard",
      "id": "my-dashboard"
    }
  ],
  "spaces": [
    "marketing"
  ],
  "includeReferences": true,
  "createNewCopies": false
}'

Response

{
  "marketing": {
    "success": true,
    "successCount": 3,
    "successResults": [
      {
        "id": "my-dashboard",
        "type": "dashboard",
        "meta": {
          "icon": "dashboardApp",
          "title": "Look at my dashboard"
        }
      },
      {
        "id": "my-vis",
        "type": "visualization",
        "meta": {
          "icon": "visualizeApp",
          "title": "Look at my visualization"
        }
      },
      {
        "id": "my-index-pattern",
        "type": "index-pattern",
        "meta": {
          "icon": "indexPatternApp",
          "title": "my-pattern-*"
        }
      }
    ]
  }
}

Request { compatibilityMode , createNewCopies , includeReferences , objects , overwrite , spaces , }

Response

Request