Catalog Integration

List catalog integrations¶

GET/api/v2/catalog-integrations
List catalog integrations.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Query Parameters¶

ParameterDescription
like string
Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.

Response¶

CodeDescription
200
successful
202
Successfully accepted the request, but it is not completed yet.

Create a catalog integration¶

POST/api/v2/catalog-integrations
Create a catalog integration.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Query Parameters¶

ParameterDescription
createMode string
Query parameter allowing support for different modes of resource creation. Possible values include:
  • errorIfExists: Throws an error if you try to create a resource that already exists.
  • orReplace: Automatically replaces the existing resource with the current one.
  • ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.

Response¶

CodeDescription
200
Successful request.
202

Fetch a catalog integration¶

GET/api/v2/catalog-integrations/{name}
Fetch a catalog integration.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Path Parameters¶

ParameterDescription
name string
Identifier (i.e. name) for the resource.

Response¶

CodeDescription
200
successful
202

Delete a catalog integration¶

DELETE/api/v2/catalog-integrations/{name}
Delete a catalog integration.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Query Parameters¶

ParameterDescription
ifExists boolean
Query parameter that specifies how to handle the request for a resource that does not exist:
  • true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
  • false: The endpoint throws an error if the resource doesn't exist.

Response¶

CodeDescription
200
202