old Inkdrop Documentation
  • Getting Started
    • 🚀Getting Started
  • FAQ
    • 📃FAQ
  • Core Concepts
    • 🧱Resource
    • 🔗Connector
    • 📦Wrapper
    • 📋Sidebar
    • 👩‍💻Code and Deployment
    • ⚙️Overriding Properties with the Codebox
  • Ressources
    • S3 Bucket
    • Lambda Functions
    • IAM Roles
    • API Endpoint
    • Fargate
    • Dynamo DB
    • RDS
    • SQS
    • SNS
  • Custom Code
    • Validating your cloud architecture
Powered by GitBook
On this page
  • Overview
  • Use Cases
  • Properties
  • Inputs
  • Outputs
  1. Ressources

API Endpoint

PreviousIAM RolesNextFargate

Last updated 1 year ago

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

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.

code box