KEkeboola
Miscellaneous

Storage API index

Returns information about the stack: services, features and available components. See the Keboola Developers documentation for more about the component architecture.

In case the system, or a project is under maintenance, you will receive a 503 response. Maintenance typically applies to a single project, for example due to migration. Be sure to use the Retry-After header when accessing the API programatically.

get/v2/storage

Request

Query parameters

excludestring

Comma-separated list of items to exclude from the response. components omits the components field; componentDetails reduces each component to id, name, type, ico64, ico128, features, flags, description and categories.

Response

Stack info including services, features, and components.

stackstring required

Identifier of the stack the project runs on.

hoststring required

Hostname of the API node that served the request.

apistring required
versionstring required

API version resolved from the request.

revisionstring required

Deployed application revision.

documentationstring required
featuresstring[] required

Example response

{
  "api": "storage",
  "version": "v2",
  "documentation": "https://api.keboola.com/?service=storage",
  "services": [
    {
      "id": "docker-runner",
      "url": "https://docker-runner.keboola.com"
    }
  ],
  "components": [
    {
      "id": "keboola.ex-db-mysql",
      "type": "extractor",
      "name": "MySQL Database Extractor",
      "description": "Extracts data from MySQL database",
      "version": 2,
      "categories": [
        "extractor",
        "database"
      ],
      "expiredOn": "2017-02-13T12:01:05+0100",
      "uri": "https://connection.keboola.com/v2/storage/components/keboola.ex-db-mysql",
      "dataTypesConfiguration": {
        "dataTypesSupport": "none"
      },
      "processorConfiguration": {
        "allowedProcessorPosition": "any"
      }
    }
  ]
}

Changes

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