KEkeboola
Components and Configurations

Restore Deleted Configurations

Moves a list of configurations out of the trash in one request. Returns a componentConfigurationsBatchRestore job.

Items carry no version: restoring is reversible and makes a new version rather than destroying one, so there is nothing to guard against a concurrent write. Every per-item rule is applied per item — a configuration that no longer exists, one belonging to an unknown component, or one the token may not manage fails alone and the rest of the batch still runs.

The job's results say per item what happened: restored lists the configurations that are back, each with the new version the restore created, and failed lists the ones still in the trash with the reason. The job itself ends as error when at least one item failed, so a caller that only polls the status still learns the batch was partial.

The variant without branch/{branchId} in the URL behaves the same as the branch endpoint with branch/default.

Initial response returns job details JobResponse. The result of the asynchronous job can be fetched via /v2/storage/jobs/{id}. When the job completes, final result is BatchRestoreJobResult.

Parameters of job will be BatchRestoreJobParams.

post/v2/storage/components/configs/batch-restore

Request

Request body

Example request

{
  "configurations": [
    {
      "componentId": "keboola.ex-db-mysql",
      "configurationId": "main-1"
    }
  ]
}

Response

Job accepted; returns job details.

idstring required

Job ID.

statusstring required

Current status of the job.

urlstring required

API detail URL for the job.

tableIdstring nullable required

ID of the table affected by the job.

operationNamestring required

Type of operation performed.

operationParamsobject required

Parameters for the operation.

createdTimestring date-time required

Job creation timestamp.

startTimestring date-time nullable required

Job start timestamp.

endTimestring date-time nullable required

Job end timestamp.

runIdstring nullable required

Run ID for the job.

Example response

{
  "id": "22077337",
  "status": "waiting",
  "url": "https://connection.keboola.com/v2/storage/jobs/22077337",
  "tableId": null,
  "operationName": "workspaceLoad",
  "operationParams": {
    "workspaceId": "78423",
    "preserve": false,
    "input": [
      {
        "source": "in.c-application-testing.cashier-data",
        "destination": "my-table"
      }
    ],
    "queue": "main_fast"
  },
  "createdTime": "2017-02-13T16:41:18+0100",
  "startTime": null,
  "endTime": null,
  "runId": null,
  "results": null,
  "creatorToken": {
    "id": "27978",
    "description": "john.doe@keboola.com"
  },
  "actor": {
    "type": "token",
    "id": "27978",
    "name": "john.doe@keboola.com",
    "adminId": 1234
  },
  "metrics": {
    "inCompressed": false,
    "inBytes": 0,
    "inBytesUncompressed": 0,
    "outCompressed": false,
    "outBytes": 0,
    "outBytesUncompressed": 0
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.