Server Management APIs

Server Management API

v2.1.0

Base URL:https://api.atlan.com

Core server lifecycle and monitoring endpoints for health checks, readiness probes, and graceful shutdown operations.

Authentication

Bearer TokenRequired

Requires valid authentication token for all server management operations

Header:Authorization

Rate limit: 1000 requests per minute (higher limit for monitoring endpoints)

Endpoints

Health Check

GET

/server/health

Retrieve comprehensive system health information including platform details, resource usage, and network configuration. Essential for monitoring and diagnostics.

Response

200System health information retrieved successfully

platformstringREQUIRED

Operating system platform

Example:"Darwin"

platform_releasestringREQUIRED

Platform release version

Example:"24.6.0"

platform_versionstringREQUIRED

Detailed platform version string

Example:"Darwin Kernel Version 24.6.0"

architecturestringREQUIRED

System architecture

Example:"arm64"

hostnamestringREQUIRED

System hostname

Example:"hostname.local"

ip_addressstringREQUIRED

Primary IP address

Example:"192.168.1.100"

mac_addressstringREQUIRED

Primary MAC address

Example:"aa:bb:cc:dd:ee:ff"

processorstringREQUIRED

Processor type

Example:"arm"

ramstringREQUIRED

Total RAM capacity

Example:"16 GB"

Error Codes

401

Unauthorized

Missing or invalid authentication token

500

Internal Server Error

Server error during shutdown process

503

Service Unavailable

Server is in the process of shutting down

Code examples - Health Check

cURL

BASH Request (cURL)

curl -X GET "https://api.atlan.com/server/health" \
-H "Authorization: Bearer YOUR_API_TOKEN"

Python

Python Request (Python)

import requests

response = requests.get(
  "https://api.atlan.com/server/health",
  headers={"Authorization": "Bearer YOUR_API_TOKEN"}
)
health_data = response.json()

JavaScript

JavaScript Request (JavaScript)

const response = await fetch('https://api.atlan.com/server/health', {
headers: {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}
});

const healthData = await response.json();