For the complete documentation index, see llms.txt. This page is also available as Markdown.

get__

GET /

API Status

Check if the Flashgate API is running and accessible.

This endpoint is useful for:

  • Health monitoring

  • Load balancer health checks

  • Verifying API connectivity

TypeScript Client Library

// Using the Flashgate TypeScript client
import { FlashgateClient } from '@flashgate/client';

const client = new FlashgateClient({ accessToken: 'your-access-token' });

// Check API root status
try {
  const result = await client.health.root();
  console.log('API status:', result);
} catch (error) {
  console.error('API status check failed:', error);
}

Code Samples

Example responses

200 Response

Responses

Status
Meaning
Description
Schema

200

API is running

Inline

Response Schema

Status Code 200

Name
Type
Required
Restrictions
Description

» message

string

false

none

none

Last updated

Was this helpful?