Schemas API Endpoint

Audience: All Immuta Users

Content Summary: This page describes the schemas endpoint of the Immuta API and its request and response parameters.

Note

Additional fields may be included in some responses you receive; however, these attributes are for internal purposes and are therefore undocumented.

Search for Schemas

EndpointQuery ParametersResponse Parameters

Endpoint

Method	Path	Purpose
GET	`/schemas`	Search across all schemas in the handler table.

Query Parameters

Attribute	Description	Required
SearchText	`string` Used to filter returned schemas. The query is executed with a wildcard prefix and suffix.	No

Response Parameters

Attribute	Description
Values	`metadata` The `name` and `count` for each result.
Name	`string` The name of the schema.
Count	`integer` The total number of data sources attached to that schema.

Request Example

This example request gets all of the schemas with the string "medical" in their name.

curl \
    --request GET \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer dea464c07bd07300095caa8" \
    https://demo.immuta.com/schemas?searchText=medical

Response Example

{
  "values": [
    {
      "name": "medical_records",
      "count": 1
    }
  ]
}