Introduction

The LayerOps API provides a comprehensive way to control and manage your resources programmatically.
To get started, you can easily create a LayerOps account and generate an API Key if you have the necessary permissions within a project. This API Key is project-bound and inherits the rights of the user who created it by default.
With the API Key in hand, you can use the API, enabling you to integrate it seamlessly into your existing workflows.

api keys

The project administrator can create an API Key with the groups he wants. Useful for giving a user or machine access only to certain API endpoints.
Access full API documentation (OpenAPI) at https://api.layerops.com/api.

Authentication

First you need to create an API Key. To do this, select a project and go to the "security" menu and select "API Keys". On this page, you can click on the create button. You'll then need to enter a name and a group to attach to this API Key.

create api key

Once created, you will have access to the new API Key information.

api key info

To use this API Key, you must pass the following header in your calls: X-API-KEY: <Key ID>:<API Key secret>. Where you must replace Key ID and API Key secret with the values given in the modal.

For example, with the previously created keys, to retrieve a service, the cURL call would be:

curl -X 'GET' \
  'https://api.layerops.com/v1/services/6cf51dd9-34fe-437a-a4e1-24ce339dcede' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: LYPM7Z3JVYPRVWWYUE64FU4C1:2933f1ae-d1c9-48e3-aff2-0646d740996f'
Table of Contents