Copy saved objects between spaces

Base URL: https://{kibana_url}

POST /api/spaces/_copy_saved_objects

Auth

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

Privileges copySavedObjectsToSpaces

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

compatibilityMode boolean · default: false: Apply various adjustments to the saved objects that are being copied to maintain compatibility between different Kibana versions. Use this option only if you encounter issues with copied saved objects. This option cannot be used with the createNewCopies option.
createNewCopies boolean · default: true: Create new copies of saved objects, regenerate each object identifier, and reset the origin. When used, potential conflict errors are avoided. This option cannot be used with the overwrite and compatibilityMode options.
includeReferences boolean · default: false: When set to true, all saved objects related to the specified saved objects will also be copied into the target spaces.
objects object[] · max items: 1000 required
overwrite boolean · default: false: When set to true, all conflicts are automatically overridden. When a saved object with a matching type and identifier exists in the target space, that version is replaced with the version from the source space. This option cannot be used with the createNewCopies option.
spaces string[] · max items: 100 required

Response

200

OK: A successful request.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

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.

Console Kibana Dev Tools

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

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

The response for successfully copying a dashboard with the my-dashboard ID, including all references from the default space to the marketing space. The result indicates a successful copy and all three objects are created. Since these objects were created as new copies, each entry in the successResults array includes a destinationId attribute.

{
  "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

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.

Console Kibana Dev Tools

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

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

The response for successfully copying a dashboard with the my-dashboard ID with createNewCopies turned off. The result indicates a successful copy and all three objects are created.

{
  "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-*"
        }
      }
    ]
  }
}