Skip to main content

GraphQL API

Fleet Control provides a GraphQL API that allows you to interact with the platform programmatically. This API is designed to be flexible, and it can be used to automate tasks, integrate with other systems, and more. This section of the documentation provides an overview of the API, including how to authenticate, make requests, and perform common tasks. The API can be accessed at:

https://api.fleetcontrol.nordcloudapp.com/graphql

Playground​

There is a GraphQL Playground available that you can use to explore the API and test queries and mutations. You can access it by clicking the link or by hovering over your profile picture in the top right corner and selecting API Playground from the dropdown menu.

Documentation Explorer​

Click Show Documentation Explorer in the top left corner to see the available queries and mutations. This will show you all the available operations, including their input and output types, and descriptions.

Next click one of the root types to see the available queries and mutations and explore the API. There is also a search bar that you can use to find specific operations and types.

Performing operations​

To perform an operation, you can write a query or mutation in the left pane and then click the Execute query button to execute it. The result will be displayed in the right pane.

caution

Mutations will modify the state of the system and should be used with caution. Make sure you understand what a mutation does before executing it.

Usage​

To use API outside the Playground, you need to send an HTTP POST request to the API endpoint with a JSON body containing the query or mutation you want to execute. There are two mandatory headers that you need to include in your request:

  • X-Api-Key: The API key that you use to authenticate with the API.
  • X-Customer-Id: The ID of the customer you want to interact with.

For example, to get the onboarding template for AWS, you can use the following curl command:

curl 'https://api.fleetcontrol.nordcloudapp.com/graphql' \
  -X POST \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Key: <YOUR API KEY HERE>' \
  -H 'X-Customer-Id: <YOUR CUSTOMER ID HERE>' \
  --data '{
    "query": "{ awsOnboardingTemplate }"
  }'