Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wherobots foreign-catalog API

The foreign-catalog API from Wherobots — 4 operation(s) for foreign-catalog.

Wherobots foreign-catalog API is one of 34 APIs that Wherobots publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include foreign-catalog. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 4 paths, and defines 20 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.

Requests are made against a single base URL, https://api.cloud.wherobots.com.

7 operations 4 paths 20 schemas 1 DELETE2 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://api.cloud.wherobots.com
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Wherobots foreign-catalog API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerToken). An API key is passed in the header as X-API-Key (wherobotsApiKey).

  • wherobotsApiKey — A Wherobots-generated API key

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

foreign-catalog 7
GET
/foreign-catalog
List foreign catalogs
listForeignCatalogs → 200400401403404409422500
POST
/foreign-catalog
Create a foreign catalog connection
createForeignCatalog body → 201400401403404409422500
GET
/foreign-catalog/{catalog_id}
Get a foreign catalog
getForeignCatalog 1 param → 200400401403404409422500
PUT
/foreign-catalog/{catalog_id}
Update a foreign catalog
updateForeignCatalog 1 param body → 200400401403404409422500
DELETE
/foreign-catalog/{catalog_id}
Delete a foreign catalog
deleteForeignCatalog 1 param → 204400401403404409422500
POST
/foreign-catalog/test-connection
Test a new foreign catalog connection
testUnsavedForeignCatalogConnection body → 204400401403404409422500
POST
/foreign-catalog/{catalog_id}/test-connection
Test an existing foreign catalog connection
testExistingForeignCatalogConnection 1 param → 204400401403404409422500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are CloudConnectionRead (11 properties), AwsGlueForeignCatalogRead (8 properties), S3TablesForeignCatalogRead (8 properties), ErrorInfo (7 properties). Each schema is shown below with its type and property counts.

IcebergForeignCatalogRead
object
5 properties 4 required
ErrorInfo
object
7 properties 4 required
AwsGlueForeignCatalogRead
object
8 properties 7 required
AwsGlueForeignCatalogUpdate
object
Request model for updating an AWS Glue foreign catalog.
2 properties 1 required
S3TablesForeignCatalogUpdate
object
Request model for updating an Amazon S3 Tables foreign catalog.
2 properties 1 required
UnityDeltaForeignCatalogUpdate
object
Request model for updating a Unity Delta foreign catalog. Used for OpenAPI schema generation.
4 properties 1 required
DeltaForeignCatalogRead
object
4 properties 4 required
S3TablesForeignCatalogCreate
object
Request model for creating an Amazon S3 Tables foreign catalog.
5 properties 5 required
ForeignCatalogAccessType
string
Enum for foreign catalog access modes (e.g. read-only vs. read-write).
ErrorBody
object
2 properties 2 required
CloudProvider
string
CloudConnectionRead
object
11 properties 5 required
AwsGlueForeignCatalogCreate
object
Request model for creating an AWS Glue foreign catalog.
6 properties 5 required
S3TablesForeignCatalogRead
object
8 properties 8 required
UnityIcebergForeignCatalogCreate
object
Request model for creating a Unity Iceberg foreign catalog.
6 properties 5 required
UnityIcebergForeignCatalogUpdate
object
Request model for updating a Unity Iceberg foreign catalog. Used for OpenAPI schema generation.
6 properties 1 required
CloudConnectionBinding
object
A resource that references (is "bound" to) a cloud connection. The binding kinds live in different databases (storage integrations in api-db, Glue and S3 Table…
3 properties 3 required
UnityDeltaForeignCatalogCreate
object
Request model for creating a Unity Delta foreign catalog.
4 properties 4 required
ErrorClass
string
CloudConnectionManagedBy
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wherobots-foreign-catalog-api-openapi.yml Raw ↑

Other APIs Wherobots publishes across the network.

Wherobots apikey API
Wherobots audit-log API
Wherobots catalogs API
Wherobots cloud-connections API
Wherobots coupon API
Wherobots environment-override--preset API
Wherobots environment-preset API
Wherobots files API
Wherobots Flags API
Wherobots Health API
Wherobots Is Super User API
Wherobots jupyter_lab API