Twingate

Admin API Overview

Overview

Twingate provides an Admin API to Enterprise tier customers. If you're interested in accessing the Twingate Admin API and you are not a current Enterprise tier customer, please contact us.

Our Admin API is GraphQL-based and currently provides the ability to:

  • Create, read, update, and delete all Resources
  • Create, read, update, and delete all Groups
  • Read all Users
  • Read all Remote networks

API schema documentation is part of the GraphQL API endpoint and is always up to date. See the next section on how to access the Admin API.

Getting started

In order to access the GraphQL endpoint for your Twingate network, you first need to generate an API token in the Admin console. You can find this in the Settings > API section.

Once you have your API token available, our Admin API GraphQL endpoint is available at the following address:

  • https://<YOUR NETWORK>.twingate.com/api/graphql/
  • You will also need to set a custom HTTP header, X-API-KEY with the value of your API key.

GraphQL clients

If you're looking for a query GUI, GraphiQL is very easy to use. You can get started quickly on Mac with Homebrew:

brew cask install graphiql

If you're using Python, we'd recommend the gql library, which allows you to get started with just a few lines of code and a query string.

Updated 2 months ago


Admin API Overview


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.