Skip to content


Connect to GraphQL API#

API interactions in Lagoon are done via GraphQL. In order to authenticate to the API, you need a JWT (JSON Web Token), which will authenticate you against the API via your SSH public key.

To generate this token, use the remote shell via the token command:

Get token
ssh -p [PORT] -t lagoon@[HOST] token connection string:

Get token
ssh -p 22 -t token

This will return a long string, which is the JWT token.

We also need the URL of the API endpoint. Contact your Lagoon administrator for this.

For this is

Now we need a GraphQL client! Technically this is just HTTP, but we suggest GraphiQL. It has a nice UI that allows you to write GraphQL requests with autocomplete. Download, install and start it. [GraphiQL App]

Enter the API endpoint URL. Then click on "Edit HTTP Headers" and add a new Header:

  • "Header name": Authorization
  • "Header value": Bearer [jwt token] (make sure that the JWT token has no spaces, that won't work)

Editing HTTP Headers in the GraphiQL UI.

Close the HTTP Header overlay (press ESC) and now you are ready to make your first GraphQL Request!

Enter this on the left window:

Get all projects
query whatIsThere {
  allProjects {
    environments {

And press the ▶️ button (or press CTRL+ENTER).

Entering a query in the GraphiQL UI.

If all went well, you should see your first GraphQL response.


The Lagoon GraphQL API can not only display objects and create objects, but it also has the capability to update existing objects. All of Lagoon's GraphQL uses best practices.


Mutation queries in GraphQL modify the data in the data store, and return a value. They can be used to insert, update, and delete data. Mutations are defined as a part of the schema._

Update the branches to deploy within a project:

Update deploy branches
mutation editProjectBranches {
  updateProject(input:{id:109, patch:{branches:"^(prod|stage|dev|update)$"}}) {

Update the production environment within a project:


This requires a redeploy in order for all changes to be reflected in the containers.

Update production environment
mutation editProjectProductionEnvironment {
  updateProject(input:{id:109, patch:{productionEnvironment:"prod"}}) {

You can also combine multiple changes into a single query:

Multiple changes
mutation editProjectProductionEnvironmentAndBranches {
  updateProject(input:{id:109, patch:{productionEnvironment:"prod", branches:"^(prod|stage|dev|update)$"}}) {