Skip to main content

Introduction

The meshStack API allows you to read and manage resources in meshStack programmatically. This page helps you get started.

tip

If you are not familiar with the different types of objects in meshStack, we recommend reading about them in the product documentation before working with the API.

Getting Started​

You can explore available endpoints in this documentation and use the integrated Request tool to test them against your meshStack. Alternatively you can download the OpenAPI specification or Postman Collection to use locally in your favorite tools.

Authentication​

The recommended way to authenticate is using API Keys. API Keys support fine-grained, scoped permissions and use OAuth Bearer Token authentication.

Versioning​

The meshStack API versions each endpoint individually using custom media types. You must provide a versioned Accept and Content-Type header in every request. See Versioning for more details.

Using the Postman Collection​

You can use the provided Postman Collection to quickly get started with the API:

  1. Import the Postman Collection into Postman.
  2. Open the Authorization tab of the collection and configure your API Key credentials.
  3. Set the hostname collection variable to your meshStack instance URL.