First steps

How to get started

Apispark is a platform that makes it possible to access a REST API and send the retrieved data to Logscale.

Everything you need to get up and running

The following steps are necessary to create a job and retrieve data from a REST API and write it to a logscale repository. As an overview, here are the individual steps that will be explained in a moment:

  • Repository, the data store at Logscale where retrieved data is stored.
  • Endpoint, the REST API that will be accessed. Depending on the REST API, authentication is required.
  • Job, here the repository, the endpoint and an interval are set.

Create your first endpoint

Let's start by creating an endpoint. We have already learned above that an endpoint means the REST API that is to be addressed. First we need a name and the API endpoint url. Then we can set the authentication method. According to the selection, new fields will appear that have to be filled in.

Create a new endpoint

Once everything is saved, you can move on to the next step.

Connect the repository

As with the endpoint, a name must be entered for the repository, here it is recommended to take the same name of the logscale repository. Specify the location of the repository. Here you can choose between the community and the cloud version. The cloud variant is the paid variant of Logscale.

Create a new repository

The last thing to add is the ingest token. This can be found in the Logscale repository under Settings > Ingest Token. Copy it into the field and save everything. Please note that the ingest token is unique, the repository can only be created once.

Verify the repository, to activate it

For verification a code is sent to the repository to check if the connection works and you are in possession of it. You have to copy this code and store it in the settings. If this is successful, the repository is active and can be used.

Example of a verification token

The job

Finally, everything comes together in the job. Here, the endpoint and the repository are selected and, together with the interval, form a complete job.

Create a new job

This only needs a name and is then active. The overview page shows when the job will run next.