Method Path Description
POST /v1/bdbs/{uid}/actions/import Initiate manual dataset import

Initiate manual dataset import

POST /v1/bdbs/{int: uid}/actions/import

Initiate a manual import process.

Required permissions

Permission name
start_bdb_import

Request

Example HTTP request

POST /bdbs/1/actions/import 

Example JSON body

{
    "dataset_import_sources": [
        {
            "type": "url",
            "url": "http://..."
        },
        {
            "type": "url",
            "url": "redis://..."
        }
    ],
    "email_notification": true
}

This request initiates an import process using dataset_import_sources values that were previously configured for the database.

Request headers

Key Value Description
Host cnm.cluster.fqdn Domain name
Accept application/json Accepted media type
Content-Length 0 Length of the request body in octets

URL parameters

Field Type Description
uid integer The unique ID of the database

Request body

The request may contain a subset of the BDB JSON object, which includes the following import-related attributes:

Field Type Description
dataset_import_sources array of dataset_import_sources objects Details for the import sources. Call GET /jsonschema on the bdb object and review the dataset_import_sources field to retrieve the object’s structure.
email_notification boolean Enable/disable an email notification on import failure/ completion. (optional)
Note:
Other attributes are not allowed and will cause the request to fail.

Response

Returns a status code.

Status codes

Code Description
200 OK The request is accepted and is being processed. In order to monitor progress, the import_status, import_progress, and import_failure_reason attributes can be consulted.
404 Not Found Attempting to perform an action on a nonexistent database.
406 Not Acceptable Not all the modules loaded to the database support ‘backup_restore’ capability.
409 Conflict Database is currently busy with another action. In this context, this is a temporary condition and the request should be reattempted later.