# Synthetics API > Synthetics API on Apizie: 21 endpoints (Associates a canary with a group. Using groups can help you with managing and automating your canaries, and…, Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries…, Creates a group which you can use to associate canaries with each other, including cross-Region canaries.…, Retrieves complete information about one canary. You must specify the name of the canary that you want. To…, …) 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://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `cloud:amazonaws-synthetics` - Category: Cloud - Status: byok - Source: https://github.com/mermade/aws2openapi - Page: https://zieapi.vercel.app/api/cloud/amazonaws-synthetics - OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-synthetics/openapi.json Amazon CloudWatch Synthetics You can use Amazon CloudWatch Synthetics to continually monitor your services. You can create and manage canaries , which are modular, lightweight scripts that monitor your endpoints and… ## Endpoints ### Associates a canary with a group. Using groups can help you with managing and automating your canaries, and… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/associate-resource` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | groupIdentifier | string | yes | Specifies the group. You can specify the group name, the ARN, or the group ID as the GroupIdentifier . | | body | object | yes | JSON request body | ### Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/create-canary` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | body | object | yes | JSON request body | ### Creates a group which you can use to associate canaries with each other, including cross-Region canaries.… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/create-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | body | object | yes | JSON request body | ### Retrieves complete information about one canary. You must specify the name of the canary that you want. To… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/get-canary` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | name | string | yes | The name of the canary that you want details for. | ### Updates the configuration of a canary that has already been created. You can't use this operation to update… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/update-canary` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | name | string | yes | The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries . You cannot change the name of a… | | body | object | yes | JSON request body | ### Permanently deletes the specified canary. If you specify DeleteLambda to true , CloudWatch Synthetics also… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/delete-canary` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | name | string | yes | The name of the canary that you want to delete. To find the names of your canaries, use DescribeCanaries . | | deleteLambda | boolean | no | Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false. Type: Boolean | ### Returns information about one group. Groups are a global resource, so you can use this operation from any… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/get-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | groupIdentifier | string | yes | Specifies the group to return information for. You can specify the group name, the ARN, or the group ID as the GroupIdentifier . | ### Deletes a group. The group doesn't need to be empty to be deleted. If there are canaries in the group, they… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/delete-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | groupIdentifier | string | yes | Specifies which group to delete. You can specify the group name, the ARN, or the group ID as the GroupIdentifier . | ### This operation returns a list of the canaries in your account, along with full details about each canary.… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/describe-canaries` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | | body | object | yes | JSON request body | ### Use this operation to see information from the most recent run of each canary that you have created. This… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/describe-canaries-last-run` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | | body | object | yes | JSON request body | ### Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions . `POST https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/describe-runtime-versions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | | body | object | yes | JSON request body | ### Removes a canary from a group. You must run this operation in the Region where the canary exists. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/disassociate-resource` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | groupIdentifier | string | yes | Specifies the group. You can specify the group name, the ARN, or the group ID as the GroupIdentifier . | | body | object | yes | JSON request body | ### Retrieves a list of runs for a specified canary. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/get-canary-runs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | name | string | yes | The name of the canary that you want to see runs for. | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | | body | object | yes | JSON request body | ### Returns a list of the groups that the specified canary is associated with. The canary that you specify must… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/list-associated-groups` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | resourceArn | string | yes | The ARN of the canary that you want to view groups for. | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | | body | object | yes | JSON request body | ### This operation returns a list of the ARNs of the canaries that are associated with the specified group. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/list-group-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | groupIdentifier | string | yes | Specifies the group to return information for. You can specify the group name, the ARN, or the group ID as the GroupIdentifier . | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | | body | object | yes | JSON request body | ### Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/list-groups` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | | body | object | yes | JSON request body | ### Displays the tags associated with a canary or group. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/list-tags-for-resource` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | resourceArn | string | yes | The ARN of the canary or group that you want to view tags for. The ARN format of a canary is arn:aws:synthetics: Region : account-id… | ### Assigns one or more tags (key-value pairs) to the specified canary or group. Tags can help you organize and… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/tag-resource` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | resourceArn | string | yes | The ARN of the canary or group that you're adding tags to. The ARN format of a canary is arn:aws:synthetics: Region : account-id :canary:… | | body | object | yes | JSON request body | ### Use this operation to run a canary that has already been created. The frequency of the canary runs is… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/start-canary` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | name | string | yes | The name of the canary that you want to run. To find canary names, use DescribeCanaries . | ### Stops the canary to prevent all future runs. If the canary is currently running,the run that is in progress… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/stop-canary` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | name | string | yes | The name of the canary that you want to stop. To find the names of your canaries, use ListCanaries . | ### Removes one or more tags from the specified resource. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/untag-resource` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | resourceArn | string | yes | The ARN of the canary or group that you're removing tags from. The ARN format of a canary is arn:aws:synthetics: Region : account-id… | | tagKeys | array | yes | The list of tag keys to remove from the resource. | ## Example ``` curl "https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/associate-resource" \ -H "x-api-key: $APIZIE_KEY" \ -H "x-upstream-key: $PROVIDER_KEY" ``` ## FAQ ### How do I call the Synthetics API? Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:amazonaws-synthetics/associate-resource with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the Synthetics API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Synthetics itself also needs your own key from amazonaws.com. ### Can AI agents use the Synthetics API? Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-synthetics. ### What is the status of the Synthetics API? Needs your own provider key (bring your own key)