Cortex Search Service

List cortex search services¶

GET/api/v2/databases/{database}/schemas/{schema}/cortex-search-services
Lists the cortex search services under the database and schema.

Path Parameters¶

ParameterDescription
database string
Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases.
schema 
Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database.

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.
fromName string
Query parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.
showLimit integer
Query parameter to limit the maximum number of rows returned by a command.

Response¶

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

Create a cortex search service¶

POST/api/v2/databases/{database}/schemas/{schema}/cortex-search-services
Create a cortex search service, with standard create modifiers as query parameters. See the Cortex Search Service component definition for what is required to be provided in the request body.

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 cortex search service¶

GET/api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{name}
Fetch a Cortex Search Service.

Path Parameters¶

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

Response¶

CodeDescription
200
successful
202

Delete a cortex search service¶

DELETE/api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{name}
Delete a cortex search service with the given name. If ifExists is used, the operation will succeed even if the object does not exist. Otherwise, there will be a failure if the drop is unsuccessful.

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

Query a Cortex Search Service¶

POST/api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{service_name}:query
Query a Cortex Search Service to get search results.

Path Parameters¶

ParameterDescription
service_name string
The name of the Cortex Search Service.

Response¶

CodeDescription
200
OK

Suggest from a Cortex Search Service¶

POST/api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{service_name}:suggest
Suggest from a Cortex Search Service to get auto-complete or contextual suggestions

Path Parameters¶

ParameterDescription
service_name string
The name of the Cortex Search Service

Response¶

CodeDescription
200
OK

Suspend a cortex search service¶

POST/api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{name}:suspend
Suspends one or both of the indexing or serving targets of a cortex search service.

Response¶

CodeDescription
200
202

Resume the cortex search service¶

POST/api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{name}:resume
Resume the cortex search service

Response¶

CodeDescription
200
202