Meilisearch

Overview

Use Meilisearch credentials to make authenticated API calls through Alter Vault without exposing API keys in code.

Property	Value
Template ID	meilisearch
Category	Search
Credential Type	API Key

Step 1: Get Credentials

Log in to Meilisearch Cloud

Log in to Meilisearch Cloud and open the project.

Open API keys

Open Settings > API keys.

Copy a key

Copy the Default Search API Key (read) or Default Admin API Key (read/write).

Warning

Never share credentials publicly. Store them securely and only enter them in the Alter Vault Developer Portal.

Step 2: Add to Alter Vault

Open the Developer Portal

Go to portal.alterauth.com and navigate to the application.

Add Meilisearch

Go to Managed Secrets > Add Provider > Meilisearch.

Enter credentials

Paste the API Key into the credential field.

Enter the deployment endpoint

Paste the Project URL. Copy it from the Meilisearch Cloud dashboard (or use a self-hosted instance’s HTTPS host). Alter derives this credential’s allowed hosts from that exact host, so proxied calls can only ever reach the deployment. The allowlist cannot be widened or edited separately; rotate the credential with a new endpoint to retarget it.

Save

Click Save. You’ll receive a grant_id to use with the SDK.

Using in Code

response = await alter_app.request(
    HttpMethod.POST,
    "https://YOUR-PROJECT.meilisearch.io/indexes/movies/search",
    grant_id="YOUR_GRANT_ID",
    json={"q": "interstellar", "limit": 5},
)

Policy-cataloged operations

Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls.

Operation ID	Families	Method	Provider path	Notes
list_indexes	read	GET	/indexes	—
get_index	read	GET	/indexes/{indexUid}	—
create_index	write	POST	/indexes	—
update_index	write	PATCH	/indexes/{indexUid}	—
delete_index	delete	DELETE	/indexes/{indexUid}	—
swap_indexes	write	POST	/swap-indexes	—
get_documents	read	GET	/indexes/{indexUid}/documents	—
get_document	read	GET	/indexes/{indexUid}/documents/{documentId}	—
documents_by_query_post	read	POST	/indexes/{indexUid}/documents/fetch	—
replace_documents	write	POST	/indexes/{indexUid}/documents	—
update_documents	write	PUT	/indexes/{indexUid}/documents	—
edit_documents_by_function	write	POST	/indexes/{indexUid}/documents/edit	—
delete_document	delete	DELETE	/indexes/{indexUid}/documents/{documentId}	—
delete_documents_batch	delete	POST	/indexes/{indexUid}/delete-batch	—
delete_documents_by_filter	delete	POST	/indexes/{indexUid}/documents/delete	—
clear_all_documents	delete	DELETE	/indexes/{indexUid}/documents	—
search_with_post	read	POST	/indexes/{indexUid}/search	—
search_with_url_query	read	GET	/indexes/{indexUid}/search	—
multi_search_with_post	read	POST	/multi-search	—
search	read	POST	/indexes/{indexUid}/facet-search	—
similar_post	read	POST	/indexes/{indexUid}/similar	—
get_tasks	read	GET	/tasks	—
get_task	read	GET	/tasks/{taskUid}	—
cancel_tasks	write	POST	/tasks/cancel	—
delete_tasks	delete	DELETE	/tasks	—
list_api_keys	read	GET	/keys	refused by default: leaves the caller holding a provider credential (a credential_minting rule can allow it)
get_api_key	read	GET	/keys/{uidOrKey}	refused by default: leaves the caller holding a provider credential (a credential_minting rule can allow it)
create_api_key	admin	POST	/keys	refused by default: leaves the caller holding a provider credential (a credential_minting rule can allow it)
patch_api_key	admin	PATCH	/keys/{uidOrKey}	—
delete_api_key	admin, delete	DELETE	/keys/{uidOrKey}	—
get_all	read	GET	/indexes/{indexUid}/settings	—
update_all	write	PATCH	/indexes/{indexUid}/settings	—
delete_all	write	DELETE	/indexes/{indexUid}/settings	—