Skip to content

Commit 7bfd517

Browse files
odinuvodinuv
authored
Merge pull request #359 from keboola/odin-AJDA-1188
Add editor service documentation to the list of the APIs
2 parents 7742704 + a9e0d28 commit 7bfd517

File tree

2 files changed

+55
-29
lines changed

2 files changed

+55
-29
lines changed

‎docker-compose.yml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
version: '3'
2-
31
services:
42
jekyll:
53
image: quay.io/keboola/docs-jekyll

‎overview/api/index.md‎

Lines changed: 55 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,26 @@ Many of these APIs require a *Storage API token*, specified in the `X-StorageApi
1515
All parts of the Keboola platform can be controlled via an API.
1616
The main APIs for our components are:
1717

18-
| API | Description |
19-
|-----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
20-
| [Keboola Storage API](https://keboola.docs.apiary.io/) | [Storage](/integrate/storage/) is the main Keboola component storing all data. |
21-
| [Keboola Management API](https://keboolamanagementapi.docs.apiary.io/) | API managing Keboola projects and users (and notifications and features). |
22-
| [Billing API](https://keboolabillingapi.docs.apiary.io/#) | Billing API for Pay as You Go projects. |
23-
| [Developer Portal API](https://kebooladeveloperportal.docs.apiary.io/#) | Developer Portal is an application separated from Keboola for [creating components](/extend/component/). |
24-
| [Encryption API](https://keboolaencryption.docs.apiary.io/#) | Provides [Encryption](/overview/encryption/). |
25-
| [Importer API](https://app.swaggerhub.com/apis-docs/keboola/import) | [Importer](/integrate/storage/api/importer/) is a helper service for easy table imports. |
26-
| [Notifications API](https://app.swaggerhub.com/apis/odinuv/notifications-service) | API to subscribe to events, e.g., failed orchestrations. |
27-
| [OAuth Broker API](https://oauthapi3.docs.apiary.io/#) | OAuth Broker is a component managing [OAuth authorizations](/extend/common-interface/oauth/#authorize) of other components. |
28-
| [Query API](https://query.keboola.com/api/v1/documentation) | Query is a service for running SQL queries on Snowflake and BigQuery. |
29-
| [Queue API](https://app.swaggerhub.com/apis-docs/keboola/job-queue-api) | Queue is a service for [running components](/extend/docker-runner/) and managing [Jobs](/integrate/jobs/). |
30-
| [Scheduler API](https://app.swaggerhub.com/apis/odinuv/scheduler) | API to automate configurations. |
31-
| [Stream API](https://stream.keboola.com/v1/documentation/) | The Keboola Stream API allows you to ingest small and frequent events into your project’s storage. |
32-
| [Synchronous Actions API](https://app.swaggerhub.com/apis/odinuv/sync-actions) | API to trigger [Synchronous Actions](/extend/common-interface/actions/). This is a partial replacement of Docker Runner API and may not be available on all stacks. |
33-
| [Templates API](https://templates.keboola.com/v1/documentation/) | The Keboola Templates API allows you to apply a [template](/cli/templates/). |
34-
| [Vault](https://vault.keboola.com/docs/swagger.yaml) | Service handling variables & credentials storage. |
35-
| [Workspaces API](https://sandboxes.keboola.com/documentation) | Workspaces API for V2 workspaces. |
36-
18+
| API | Description |
19+
|-------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
20+
| [Keboola Storage API](https://keboola.docs.apiary.io/) | [Storage](/integrate/storage/) is the main Keboola component storing all data. |
21+
| [Keboola Management API](https://keboolamanagementapi.docs.apiary.io/) | API managing Keboola projects and users (and notifications and features). |
22+
| [AI API](https://ai.keboola.com/docs/swagger.yaml) | API for supporting AI features. |
23+
| [Billing API](https://keboolabillingapi.docs.apiary.io/#) | Billing API for Pay as You Go projects. |
24+
| [Developer Portal API](https://kebooladeveloperportal.docs.apiary.io/#) | Developer Portal is an application separated from Keboola for [creating components](/extend/component/). |
25+
| [Editor API](https://editor.keboola.com/docs/swagger.yaml) | API for managing SQL editor sessions. |
26+
| [Encryption API](https://keboolaencryption.docs.apiary.io/#) | Provides [Encryption](/overview/encryption/). |
27+
| [Importer API](https://app.swaggerhub.com/apis-docs/keboola/import) | [Importer](/integrate/storage/api/importer/) is a helper service for easy table imports. |
28+
| [Notifications API](https://app.swaggerhub.com/apis/odinuv/notifications-service) | API to subscribe to events, e.g., failed orchestrations. |
29+
| [OAuth Broker API](https://oauthapi3.docs.apiary.io/#) | OAuth Broker is a component managing [OAuth authorizations](/extend/common-interface/oauth/#authorize) of other components. |
30+
| [Query API](https://query.keboola.com/api/v1/documentation) | Query is a service for running SQL queries on Snowflake and BigQuery. |
31+
| [Queue API](https://app.swaggerhub.com/apis-docs/keboola/job-queue-api) | Queue is a service for [running components](/extend/docker-runner/) and managing [Jobs](/integrate/jobs/). |
32+
| [Scheduler API](https://app.swaggerhub.com/apis/odinuv/scheduler) | API to automate configurations. |
33+
| [Stream API](https://stream.keboola.com/v1/documentation/) | The Keboola Stream API allows you to ingest small and frequent events into your project's storage. |
34+
| [Synchronous Actions API](https://app.swaggerhub.com/apis/odinuv/sync-actions) | API to trigger [Synchronous Actions](/extend/common-interface/actions/). This is a partial replacement of Docker Runner API and may not be available on all stacks. |
35+
| [Templates API](https://templates.keboola.com/v1/documentation/) | The Keboola Templates API allows you to apply a [template](/cli/templates/). |
36+
| [Vault](https://vault.keboola.com/docs/swagger.yaml) | Service handling variables & credentials storage. |
37+
| [Workspaces API](https://sandboxes.keboola.com/documentation) | Workspaces API for V2 workspaces. |
3738

3839
If you're unsure which API to use, refer to our [integration guide](/integrate/). It describes the roles of different APIs and contains examples of commonly
3940
performed actions.
@@ -61,10 +62,6 @@ Otherwise, you may encounter `Invalid Token` or unauthorized errors. The *author
6162
{
6263
...,
6364
"services": [
64-
{
65-
"id": "docker-runner",
66-
"url": "https://docker-runner.keboola.com"
67-
},
6865
{
6966
"id": "import",
7067
"url": "https://import.keboola.com"
@@ -89,10 +86,6 @@ Otherwise, you may encounter `Invalid Token` or unauthorized errors. The *author
8986
"id": "sandboxes",
9087
"url": "https://sandboxes.keboola.com"
9188
},
92-
{
93-
"id": "spark",
94-
"url": "https://spark.keboola.com"
95-
},
9689
{
9790
"id": "scheduler",
9891
"url": "https://scheduler.keboola.com"
@@ -132,11 +125,26 @@ and in application integrations, we strongly suggest using the above API call.
132125

133126
| API | Service | Region | URL |
134127
|------------------------|----------------|------------------|-----------------------------------------------------|
128+
| AI | `ai` | US Virginia AWS | https://ai.keboola.com |
129+
| AI | `ai` | US Virginia GCP | https://ai.us-east4.gcp.keboola.com |
130+
| AI | `ai` | EU Frankfurt AWS | https://ai.eu-central-1.keboola.com |
131+
| AI | `ai` | EU Ireland Azure | https://ai.north-europe.azure.keboola.com |
132+
| AI | `ai` | EU Frankfurt GCP | https://ai.europe-west3.gcp.keboola.com |
135133
| Billing | `billing` | US Virginia AWS | https://billing.keboola.com |
136134
| Billing | `billing` | US Virginia GCP | https://billing.us-east4.gcp.keboola.com |
137135
| Billing | `billing` | EU Frankfurt AWS | https://billing.eu-central-1.keboola.com |
138136
| Billing | `billing` | EU Ireland Azure | https://billing.north-europe.azure.keboola.com |
139137
| Billing | `billing` | EU Frankfurt GCP | https://billing.europe-west3.gcp.keboola.com |
138+
| Developer Portal | `developer` | US Virginia AWS | https://developer.keboola.com |
139+
| Developer Portal | `developer` | US Virginia GCP | https://developer.us-east4.gcp.keboola.com |
140+
| Developer Portal | `developer` | EU Frankfurt AWS | https://developer.eu-central-1.keboola.com |
141+
| Developer Portal | `developer` | EU Ireland Azure | https://developer.north-europe.azure.keboola.com |
142+
| Developer Portal | `developer` | EU Frankfurt GCP | https://developer.europe-west3.gcp.keboola.com |
143+
| Editor | `editor` | US Virginia AWS | https://editor.keboola.com |
144+
| Editor | `editor` | US Virginia GCP | https://editor.us-east4.gcp.keboola.com |
145+
| Editor | `editor` | EU Frankfurt AWS | https://editor.eu-central-1.keboola.com |
146+
| Editor | `editor` | EU Ireland Azure | https://editor.north-europe.azure.keboola.com |
147+
| Editor | `editor` | EU Frankfurt GCP | https://editor.europe-west3.gcp.keboola.com |
140148
| Encryption | `encryption` | US Virginia AWS | https://encryption.keboola.com |
141149
| Encryption | `encryption` | US Virginia GCP | https://encryption.us-east4.gcp.keboola.com |
142150
| Encryption | `encryption` | EU Frankfurt AWS | https://encryption.eu-central-1.keboola.com |
@@ -147,6 +155,11 @@ and in application integrations, we strongly suggest using the above API call.
147155
| Importer | `import` | EU Frankfurt AWS | https://import.eu-central-1.keboola.com |
148156
| Importer | `import` | EU Ireland Azure | https://import.north-europe.azure.keboola.com |
149157
| Importer | `import` | EU Frankfurt GCP | https://import.europe-west3.gcp.keboola.com |
158+
| Management | `management` | US Virginia AWS | https://management.keboola.com |
159+
| Management | `management` | US Virginia GCP | https://management.us-east4.gcp.keboola.com |
160+
| Management | `management` | EU Frankfurt AWS | https://management.eu-central-1.keboola.com |
161+
| Management | `management` | EU Ireland Azure | https://management.north-europe.azure.keboola.com |
162+
| Management | `management` | EU Frankfurt GCP | https://management.europe-west3.gcp.keboola.com |
150163
| Notification | `notification` | US Virginia AWS | https://notification.keboola.com |
151164
| Notification | `notification` | US Virginia GCP | https://notification.us-east4.gcp.keboola.com |
152165
| Notification | `notification` | EU Frankfurt AWS | https://notification.eu-central-1.keboola.com |
@@ -157,6 +170,11 @@ and in application integrations, we strongly suggest using the above API call.
157170
| OAuth | `oauth` | EU Frankfurt AWS | https://oauth.eu-central-1.keboola.com |
158171
| OAuth | `oauth` | EU Ireland Azure | https://oauth.north-europe.azure.keboola.com |
159172
| OAuth | `oauth` | EU Frankfurt GCP | https://oauth.europe-west3.gcp.keboola.com |
173+
| Query | `query` | US Virginia AWS | https://query.keboola.com |
174+
| Query | `query` | US Virginia GCP | https://query.us-east4.gcp.keboola.com |
175+
| Query | `query` | EU Frankfurt AWS | https://query.eu-central-1.keboola.com |
176+
| Query | `query` | EU Ireland Azure | https://query.north-europe.azure.keboola.com |
177+
| Query | `query` | EU Frankfurt GCP | https://query.europe-west3.gcp.keboola.com |
160178
| Queue | `queue` | US Virginia AWS | https://queue.keboola.com |
161179
| Queue | `queue` | US Virginia GCP | https://queue.us-east4.gcp.keboola.com |
162180
| Queue | `queue` | EU Frankfurt AWS | https://queue.eu-central-1.keboola.com |
@@ -172,6 +190,11 @@ and in application integrations, we strongly suggest using the above API call.
172190
| Storage | | EU Frankfurt AWS | https://connection.eu-central-1.keboola.com/ |
173191
| Storage | | EU Ireland Azure | https://connection.north-europe.azure.keboola.com/ |
174192
| Storage | | EU Frankfurt GCP | https://connection.europe-west3.gcp.keboola.com/ |
193+
| Stream | `stream` | US Virginia AWS | https://stream.keboola.com |
194+
| Stream | `stream` | US Virginia GCP | https://stream.us-east4.gcp.keboola.com |
195+
| Stream | `stream` | EU Frankfurt AWS | https://stream.eu-central-1.keboola.com |
196+
| Stream | `stream` | EU Ireland Azure | https://stream.north-europe.azure.keboola.com |
197+
| Stream | `stream` | EU Frankfurt GCP | https://stream.europe-west3.gcp.keboola.com |
175198
| Sync Actions | `sync-actions` | US Virginia AWS | https://sync-actions.keboola.com/ |
176199
| Sync Actions | `sync-actions` | US Virginia GCP | https://sync-actions.us-east4.gcp.keboola.com |
177200
| Sync Actions | `sync-actions` | EU Frankfurt AWS | https://sync-actions.eu-central-1.keboola.com |
@@ -182,6 +205,11 @@ and in application integrations, we strongly suggest using the above API call.
182205
| Templates | `templates` | EU Frankfurt AWS | https://templates.eu-central-1.keboola.com |
183206
| Templates | `templates` | EU Ireland Azure | https://templates.north-europe.azure.keboola.com |
184207
| Templates | `templates` | EU Frankfurt GCP | https://templates.europe-west3.gcp.keboola.com |
208+
| Vault | `vault` | US Virginia AWS | https://vault.keboola.com |
209+
| Vault | `vault` | US Virginia GCP | https://vault.us-east4.gcp.keboola.com |
210+
| Vault | `vault` | EU Frankfurt AWS | https://vault.eu-central-1.keboola.com |
211+
| Vault | `vault` | EU Ireland Azure | https://vault.north-europe.azure.keboola.com |
212+
| Vault | `vault` | EU Frankfurt GCP | https://vault.europe-west3.gcp.keboola.com |
185213
| Workspaces / Sandboxes | `sandboxes` | US Virginia AWS | https://sandboxes.keboola.com |
186214
| Workspaces / Sandboxes | `sandboxes` | US Virginia GCP | https://sandboxes.us-east4.gcp.keboola.com |
187215
| Workspaces / Sandboxes | `sandboxes` | EU Frankfurt AWS | https://sandboxes.eu-central-1.keboola.com |

0 commit comments

Comments
 (0)