Skip to main content
The Gapstack API is a REST API for tenants, projects, environments, resources, AWS accounts, and marketplace integrations. Use the interactive playground on each endpoint page, or send requests to the production base URL.

OpenAPI specification

Browse the live Swagger UI and download openapi.yaml.

​
Base URL

All paths in this reference are relative to that URL. For example, GET /healthcheck is:

​
Authenticate

Most endpoints accept either a Cognito JWT or a tenant API key. See Authentication.

​
Tenant context

Project, environment, resource, and related endpoints require a Tenant-Id header. Tenant and invitation endpoints take the tenant in the path instead, such as /tenant/{tenantId}.

​
Resource model

Gapstack resources nest in this order:
1

Tenant

The organization. Create one with POST /tenant, then create API keys and invite members.
2

Project

A grouping inside a tenant. Projects organize environments. Creating a project does not create a CloudFormation stack.
3

Environment

A deployable instance under a project. Each environment has its own CloudFormation stack, plus variables, artifacts, and deploy actions.
4

Resource

A cloud resource attached to an environment, such as a Lambda function.
Linked AWS accounts, marketplace integrations, workflows, and cost data hang off this same tenant context.

​
Pagination

List endpoints that accept limit and cursor return a page of results plus a cursor for the next page. Pass the cursor back on the following request until the response has no cursor.