Getting Started with REST API

Learn How to get started using the REST API

Workflow 1

New to REST API?

Find out why you would use the REST API

Read about why you would use the REST API, select your API, obtain a suitable token, make your first request.

  • Why Use a REST API?
  • Which REST API Should You Use?
  • Obtain Your Token
  • Make Your First Request
Start Here

Workflow 1: New to LogScale REST APIs?

Obtain some hands-on experience of running a REST API request.

1

Why Use a REST API?

Understand why you would use a REST API as opposed to a GUI.

Why use a LogScale REST API?

apiintermediate

Helps you understand why you would use a REST API to interact with LogScale, rather than the UI provided.
2

Which REST API?

Choose which REST API to use out of the many available.

Essential APIs

apiintermediate

Describes the essential APIs that are available

Administrative APIs

apiintermediate

Describes the admin-related APIs that are available
3

Obtain Your Token

Obtain a token that you can use to authenticate your requests.

Obtain Your Token

apiintermediate

Describes the various tokens types available, and where to get them.
4

Make Your First Request

Shows you how to make a REST API request.

Perform a simple request

apiintermediate

Shows you how to make a simple cluster health check request using Curl