AMPS
  • What is AMPS?
  • Getting Started
    • Installation
      • Docker
      • Kubernetes
        • Local
        • Openshift
        • AWS
    • Setup
  • Fundamentals
    • Admin
      • Monitoring
        • Message Events
        • Sessions
        • Service Monitoring
        • System Logs
        • Audit Log
        • Consumers
      • Onboarding
        • Groups
        • Users
      • Message Configuration
        • Topics
        • Actions
        • Services
        • Scripts
        • Templates
        • Routing Rules
        • API Endpoints
        • Metadata Fields
        • Keys
        • Jobs
      • Data Configuration
        • Providers
        • Environments
        • Packages
      • Tools
      • System Configuration
    • End User
      • Mailboxes
      • Universe File Agent
      • Auth Tokens
    • Python
  • Use Cases
    • For Engineers
      • GitHub Integration
    • For Support
      • Intercom Integration
  • Guides
    • Creating your first project
    • Creating your first task
    • Advanced permissions
Powered by GitBook
On this page
  1. Fundamentals
  2. Admin
  3. Message Configuration

API Endpoints

PreviousRouting RulesNextMetadata Fields

Last updated 3 years ago

API Endpoints contain method, path, and endpoint action configuration of a single API endpoint. API Endpoints make up Gateway Services but are kept distinct such that they can be reused in any number of Gateway services. Run Lambda actions that are performed at endpoints generally extend the class.The fields for defining endpoints are specified below.

Field
Description

Name*

The endpoint name

Description*

A description of the endpoint

Method*

The HTTP Method to use for this endpoint. One of GET, POST, PUT, or DELETE

Path*

A URL path starting with "/" that either directly specifies a route to match (i.e. /test), or uses a wildcard pattern that can match multiple routes (i.e. /:param or /*param). Under the hood, the API Gateway uses the for building the API. Consult the Router docs for more information regarding request path matching and parameters.

Action*

A preconfigured action of type "Run Lambda" to perform when this route is triggered.

AMPS Endpoint
Elixir Plug Router