KEkeboola
Components and Configurations

Purge Deleted Configurations

Permanently removes a list of configurations from the trash in one request, including all their versions, rows and metadata. This cannot be undone. Returns a componentConfigurationsBatchPurge job.

Every item carries the version the configuration was read at — the per-item equivalent of the If-Match header of the single-configuration purge. An item whose configuration has moved on is reported in failed with storage.components.configurations.versionMismatch and the rest of the batch still runs. The same holds for every other per-item rule: a configuration that is not in the trash, one that no longer exists, or one the token may not manage fails alone.

The job's results say per item what happened: purged lists the configurations that are gone, failed lists the ones left 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.

Only available in the default branch; development branch configurations cannot be permanently removed, and in a development branch every item fails with storage.components.cannotDeleteConfiguration. Requires the canPurgeTrash token permission.

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 BatchPurgeJobResult.

Parameters of job will be BatchPurgeJobParams.

post/v2/storage/branch/{branchId}/components/configs/batch-purge

Request

Path parameters

branchIdstring required

Request body

Example request

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

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.