# Schemas API

> Schemas API on Apizie: 31 endpoints (List the discoverers., Creates a discoverer., Describes the registry., Creates a registry., …) 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://apizie.tech/v1/cloud:amazonaws-schemas/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Amazon EventBridge Schema Registry

## Endpoints

### List the discoverers.
`GET https://apizie.tech/v1/cloud:amazonaws-schemas/list-discoverers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| discovererIdPrefix | string | no | Specifying this limits the results to only those discoverer IDs that start with the specified prefix. |
| limit | integer | no |  |
| nextToken | string | no | The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24… |
| sourceArnPrefix | string | no | Specifying this limits the results to only those ARNs that start with the specified prefix. |
| Limit | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Creates a discoverer.
`POST https://apizie.tech/v1/cloud:amazonaws-schemas/create-discoverer` (byok)

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

### Describes the registry.
`GET https://apizie.tech/v1/cloud:amazonaws-schemas/describe-registry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| registryName | string | yes | The name of the registry. |

### Creates a registry.
`POST https://apizie.tech/v1/cloud:amazonaws-schemas/create-registry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| registryName | string | yes | The name of the registry. |
| body | object | yes | JSON request body |

### Updates a registry.
`POST https://apizie.tech/v1/cloud:amazonaws-schemas/update-registry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| registryName | string | yes | The name of the registry. |
| body | object | yes | JSON request body |

### Deletes a Registry.
`POST https://apizie.tech/v1/cloud:amazonaws-schemas/delete-registry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| registryName | string | yes | The name of the registry. |

### Retrieve the schema definition.
`GET https://apizie.tech/v1/cloud:amazonaws-schemas/describe-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| registryName | string | yes | The name of the registry. |
| schemaName | string | yes | The name of the schema. |
| schemaVersion | string | no | Specifying this limits the results to only this schema version. |

### Creates a schema definition. Inactive schemas will be deleted after two years.
`POST https://apizie.tech/v1/cloud:amazonaws-schemas/create-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| registryName | string | yes | The name of the registry. |
| schemaName | string | yes | The name of the schema. |
| body | object | yes | JSON request body |

### Updates the schema definition Inactive schemas will be deleted after two years.
`POST https://apizie.tech/v1/cloud:amazonaws-schemas/update-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| registryName | string | yes | The name of the registry. |
| schemaName | string | yes | The name of the schema. |
| body | object | yes | JSON request body |

### Delete a schema definition.
`POST https://apizie.tech/v1/cloud:amazonaws-schemas/delete-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| registryName | string | yes | The name of the registry. |
| schemaName | string | yes | The name of the schema. |

### Describes the discoverer.
`GET https://apizie.tech/v1/cloud:amazonaws-schemas/describe-discoverer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| discovererId | string | yes | The ID of the discoverer. |

### Updates the discoverer
`POST https://apizie.tech/v1/cloud:amazonaws-schemas/update-discoverer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| discovererId | string | yes | The ID of the discoverer. |
| body | object | yes | JSON request body |

### Deletes a discoverer.
`POST https://apizie.tech/v1/cloud:amazonaws-schemas/delete-discoverer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| discovererId | string | yes | The ID of the discoverer. |

### Retrieves the resource-based policy attached to a given registry.
`GET https://apizie.tech/v1/cloud:amazonaws-schemas/get-resource-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| registryName | string | no | The name of the registry. |

### The name of the policy.
`POST https://apizie.tech/v1/cloud:amazonaws-schemas/put-resource-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| registryName | string | no | The name of the registry. |
| body | object | yes | JSON request body |

### Delete the resource-based policy attached to the specified registry.
`POST https://apizie.tech/v1/cloud:amazonaws-schemas/delete-resource-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| registryName | string | no | The name of the registry. |

### Delete the schema version definition
`POST https://apizie.tech/v1/cloud:amazonaws-schemas/delete-schema-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| registryName | string | yes | The name of the registry. |
| schemaName | string | yes | The name of the schema. |
| schemaVersion | string | yes | The version number of the schema |

### Describe the code binding URI.
`GET https://apizie.tech/v1/cloud:amazonaws-schemas/describe-code-binding` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| language | string | yes | The language of the code binding. |
| registryName | string | yes | The name of the registry. |
| schemaName | string | yes | The name of the schema. |
| schemaVersion | string | no | Specifying this limits the results to only this schema version. |

### Put code binding URI
`POST https://apizie.tech/v1/cloud:amazonaws-schemas/put-code-binding` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| language | string | yes | The language of the code binding. |
| registryName | string | yes | The name of the registry. |
| schemaName | string | yes | The name of the schema. |
| schemaVersion | string | no | Specifying this limits the results to only this schema version. |

### GET /v1/registries/name/{registryName}/schemas/name/{schemaName}/export#type
`GET https://apizie.tech/v1/cloud:amazonaws-schemas/export-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| registryName | string | yes | The name of the registry. |
| schemaName | string | yes | The name of the schema. |
| schemaVersion | string | no | Specifying this limits the results to only this schema version. |
| type | string | yes |  |

### Get the code binding source URI.
`GET https://apizie.tech/v1/cloud:amazonaws-schemas/get-code-binding-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| language | string | yes | The language of the code binding. |
| registryName | string | yes | The name of the registry. |
| schemaName | string | yes | The name of the schema. |
| schemaVersion | string | no | Specifying this limits the results to only this schema version. |

### Get the discovered schema that was generated based on sampled events.
`POST https://apizie.tech/v1/cloud:amazonaws-schemas/get-discovered-schema` (byok)

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

### List the registries.
`GET https://apizie.tech/v1/cloud:amazonaws-schemas/list-registries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| limit | integer | no |  |
| nextToken | string | no | The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24… |
| registryNamePrefix | string | no | Specifying this limits the results to only those registry names that start with the specified prefix. |
| scope | string | no | Can be set to Local or AWS to limit responses to your custom registries, or the ones provided by AWS. |
| Limit | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Provides a list of the schema versions and related information.
`GET https://apizie.tech/v1/cloud:amazonaws-schemas/list-schema-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| limit | integer | no |  |
| nextToken | string | no | The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24… |
| registryName | string | yes | The name of the registry. |
| schemaName | string | yes | The name of the schema. |
| Limit | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### List the schemas.
`GET https://apizie.tech/v1/cloud:amazonaws-schemas/list-schemas` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| limit | integer | no |  |
| nextToken | string | no | The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24… |
| registryName | string | yes | The name of the registry. |
| schemaNamePrefix | string | no | Specifying this limits the results to only those schema names that start with the specified prefix. |
| Limit | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Get tags for resource.
`GET https://apizie.tech/v1/cloud:amazonaws-schemas/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resource-arn | string | yes | The ARN of the resource. |

### Add tags to a resource.
`POST https://apizie.tech/v1/cloud:amazonaws-schemas/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resource-arn | string | yes | The ARN of the resource. |
| body | object | yes | JSON request body |

### Search the schemas
`GET https://apizie.tech/v1/cloud:amazonaws-schemas/search-schemas` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| keywords | string | yes | Specifying this limits the results to only schemas that include the provided keywords. |
| limit | integer | no |  |
| nextToken | string | no | The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24… |
| registryName | string | yes | The name of the registry. |
| Limit | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Starts the discoverer
`POST https://apizie.tech/v1/cloud:amazonaws-schemas/start-discoverer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| discovererId | string | yes | The ID of the discoverer. |

### Stops the discoverer
`POST https://apizie.tech/v1/cloud:amazonaws-schemas/stop-discoverer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| discovererId | string | yes | The ID of the discoverer. |

### Removes tags from a resource.
`POST https://apizie.tech/v1/cloud:amazonaws-schemas/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resource-arn | string | yes | The ARN of the resource. |
| tagKeys | array | yes | Keys of key-value pairs. |

## Example
```
curl "https://apizie.tech/v1/cloud:amazonaws-schemas/list-discoverers" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Schemas API?
Create a free Apizie key, then send GET https://apizie.tech/v1/cloud:amazonaws-schemas/list-discoverers with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Schemas API?
Yes. Add the Apizie MCP server (https://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-schemas.

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