API Endpoint

Overview

An API endpoint allows exposing an HTTP API that can be called to trigger functionality and retrieve data. The endpoint is scalable and highly available.

Use Cases

  • Expose a public API for mobile or web apps

  • Enable API calls between services and layers of architecture

  • Trigger serverless functions like AWS Lambda

Properties

  • API type: REST, SOAP, JSON-RPC, GraphQL, WebSocket etc.

  • Authentication: API Keys, IAM roles/policies, authorizers.

Properties that were left out on purpose.

  • TLS certificate: Encrypt API traffic with SSL/TLS. Default none.

  • Scaling: Increase endpoint capacity to meet traffic demands.

You can easily override these defaults by entering the desired values in the code box

Inputs

  • API call: Invoke the API over HTTP.

  • Parameters: Data passed to the endpoint by the caller.

Outputs

  • Response: Data returned by the API endpoint.

  • Metrics: Monitor API call counts, latency, errors.

PreviousIAM RolesNextFargate

Last updated