find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-web-services-canary-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Amazon Web Services synthetics Canary API
  description: 'Amazon CloudWatch Synthetics

    You can use Amazon CloudWatch Synthetics to continually monitor your services.'
tags:
- name: Canary
paths:
  /canary:
    POST:
      summary: Amazon Web Services Createcanary
      description: Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once. Do not use CreateCanary to modify an existing canary. Use UpdateCanary instead. To create canaries, you must have the CloudWatchSyntheticsFullAccess policy. If you are creating a new IAM role for the canary, you also need the iam:CreateRole, iam:CreatePolicy and iam:AttachRolePolicy permissions. For more information, see Necessary Roles and Permissions. Do not include secrets or proprietary information in your canary names. The canary name makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.
      operationId: amazonWebServicesCreateCanary
      tags:
      - Canary
  /canary/{name}:
    PATCH:
      summary: Amazon Web Services Updatecanary
      description: Updates the configuration of a canary that has already been created. You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource.
      operationId: amazonWebServicesUpdateCanary
      tags:
      - Canary
  /canary/{name}/runs:
    POST:
      summary: Amazon Web Services Getcanaryruns
      description: Retrieves a list of runs for a specified canary.
      operationId: amazonWebServicesGetCanaryRuns
      tags:
      - Canary
  /canary/{name}/start:
    POST:
      summary: Amazon Web Services Startcanary
      description: Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's Schedule. To see a canary's schedule, use GetCanary.
      operationId: amazonWebServicesStartCanary
      tags:
      - Canary
  /canary/{name}/stop:
    POST:
      summary: Amazon Web Services Stopcanary
      description: Stops the canary to prevent all future runs. If the canary is currently running,the run that is in progress completes on its own, publishes metrics, and uploads artifacts, but it is not recorded in Synthetics as a completed run. You can use StartCanary to start it running again with the canary’s current schedule at any point in the future.
      operationId: amazonWebServicesStopCanary
      tags:
      - Canary