Skip to main content

Depot API

Depot has the following APIs for data access and configuration:

  • Data API - A GraphQL and REST API for creating, managing and retrieving data
  • Depot API - A CDK API that can be used to create and manage Depot objects like datasets and stores

Depot Data API endpoints​

A deployed Depot stack hosts the following resources under the root endpoint exposed in the cloud formation output (see: cfnOutput sample above)

  • GraphQL API endpoint: https://{endpoint}/graphql
  • Rest API specification: https://{endpoint}/api

Other Depot Data endpoints​

There is an additional Lambda Gateway Function that serves as another interface for a given Depot environment (for example where you would like to interface with a Depot environment directly from cloud infrastructure such as other Lambda functions or Step Functions). You can interact with this interface by invoking the Lambda function from anywhere using the AWS SDK.

Every Depot environment will have a Lambda Gateway function deployed with the following naming convention: depot-{envId}-lambda-depot-gateway.