# OpenSearch Service Serverless API

> OpenSearch Service Serverless API on Apizie: 31 endpoints (Returns attributes for one or more collections, including the collection endpoint and the OpenSearch…, Returns attributes for one or more VPC endpoints associated with the current account. For more information,…, Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the…, Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-opensearchserverless`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://www.apizie.tech/api/cloud/amazonaws-opensearchserverless
- OpenAPI: https://www.apizie.tech/api/cloud/amazonaws-opensearchserverless/openapi.json

Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and security policies. OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for…

## Endpoints

### Returns attributes for one or more collections, including the collection endpoint and the OpenSearch…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/batch-get-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Returns attributes for one or more VPC endpoints associated with the current account. For more information,…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/batch-get-vpc-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/create-access-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/create-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/create-security-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates a security policy to be used by one or more OpenSearch Serverless collections. Security policies…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/create-security-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/create-vpc-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/delete-access-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/delete-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/delete-security-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes an OpenSearch Serverless security policy.
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/delete-security-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/delete-vpc-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/get-access-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Returns account-level settings related to OpenSearch Serverless.
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/get-account-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Returns statistical information about your OpenSearch Serverless access policies, security configurations,…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/get-policies-stats` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Returns information about an OpenSearch Serverless security configuration. For more information, see SAML…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/get-security-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Returns information about a configured OpenSearch Serverless security policy. For more information, see…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/get-security-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Returns information about a list of OpenSearch Serverless access policies.
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/list-access-policies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/list-collections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Returns information about configured OpenSearch Serverless security configurations. For more information,…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/list-security-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Returns information about configured OpenSearch Serverless security policies.
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/list-security-policies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/list-vpc-endpoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Updates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/update-access-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information,…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/update-account-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Updates an OpenSearch Serverless collection.
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/update-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/update-security-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Updates an OpenSearch Serverless security policy. For more information, see Network access for Amazon…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/update-security-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon…
`POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/update-vpc-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

## Example
```
curl "https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/batch-get-collection" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the OpenSearch Service Serverless API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/cloud:amazonaws-opensearchserverless/batch-get-collection with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the OpenSearch Service Serverless API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. OpenSearch Service Serverless itself also needs your own key from amazonaws.com.

### Can AI agents use the OpenSearch Service Serverless API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-opensearchserverless.

### What is the status of the OpenSearch Service Serverless API?
Needs your own provider key (bring your own key)