Resolve conflicts copying saved objects

Base URL: https://{kibana_url}

POST /api/spaces/_resolve_copy_saved_objects_errors

Auth

Overwrite saved objects that are returned as errors from the copy saved objects to space API.

Header parameters

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

Request body

compatibilityMode boolean · default: false
createNewCopies boolean · default: true
includeReferences boolean · default: false
objects object[] · max items: 1000 required
retries map string to object required

Response

200

OK: A successful request.

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Resolve conflict errors for a data view, visualization, and Canvas workpad by overwriting the existing saved objects. NOTE: If a prior copy attempt resulted in resolvable errors, you must include a retry for each object you want to copy, including any that were returned in the successResults array. In this example, we retried copying the dashboard accordingly.

Console Kibana Dev Tools

POST kbn:/api/spaces/_resolve_copy_saved_objects_errors
{
  "objects": [
    {
      "type": "dashboard",
      "id": "my-dashboard"
    }
  ],
  "includeReferences": true,
  "createNewCopies": false,
  "retries": {
    "sales": [
      {
        "type": "index-pattern",
        "id": "my-pattern",
        "overwrite": true
      },
      {
        "type": "visualization",
        "id": "my-vis",
        "overwrite": "true,",
        "destinationId": "another-vis"
      },
      {
        "type": "canvas",
        "id": "my-canvas",
        "overwrite": true,
        "destinationId": "yet-another-canvas"
      },
      {
        "type": "dashboard",
        "id": "my-dashboard"
      }
    ]
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/spaces/_resolve_copy_saved_objects_errors" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "objects": [
      {
        "type": "dashboard",
        "id": "my-dashboard"
      }
    ],
    "includeReferences": true,
    "createNewCopies": false,
    "retries": {
      "sales": [
        {
          "type": "index-pattern",
          "id": "my-pattern",
          "overwrite": true
        },
        {
          "type": "visualization",
          "id": "my-vis",
          "overwrite": "true,",
          "destinationId": "another-vis"
        },
        {
          "type": "canvas",
          "id": "my-canvas",
          "overwrite": true,
          "destinationId": "yet-another-canvas"
        },
        {
          "type": "dashboard",
          "id": "my-dashboard"
        }
      ]
    }
  }'

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

Resolve missing reference errors for a visualization by ignoring the error. NOTE: If a prior copy attempt resulted in resolvable errors, you must include a retry for each object you want to copy, including any that were returned in the successResults array. In this example, we retried copying the dashboard and canvas accordingly.

Console Kibana Dev Tools

POST kbn:/api/spaces/_resolve_copy_saved_objects_errors
{
  "objects": [
    {
      "type": "dashboard",
      "id": "my-dashboard"
    }
  ],
  "includeReferences": true,
  "createNewCopies": false,
  "retries": {
    "marketing": [
      {
        "type": "visualization",
        "id": "my-vis",
        "ignoreMissingReferences": true
      },
      {
        "type": "canvas",
        "id": "my-canvas"
      },
      {
        "type": "dashboard",
        "id": "my-dashboard"
      }
    ]
  }
}

Generated from the API spec

curl Shell

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

Generated from the API spec

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

Required privileges

Header parameters

Request body { }

Response

Request body