Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/pixlcore/xyops/llms.txt

Use this file to discover all available pages before exploring further.

​
Introduction

The xyOps REST API provides programmatic access to all core functionality including events, jobs, servers, monitors, alerts, and tickets. All API calls expect JSON as input (unless they are simple HTTP GETs) and return JSON as output.

​
Base URL

The main API endpoint follows this pattern: 
https://YOUR_SERVER/api/app/NAME/v1
Replace NAME with the specific API function you are calling. All requests should be HTTP GET or HTTP POST as the API dictates, and should be directed at your xyOps primary server. Example URL: 
http://sample.west.xyops.io/api/app/search_jobs/v1

​
Standard Response Format

All API responses are in JSON format and include at minimum a code property. This will be set to 0 upon success, or any other value if an error occurred.

​
Successful Response

{
  "code": 0
}

​
Error Response

In the event of an error, a description property will also be included with the error message: 
{
  "code": "session",
  "description": "No Session ID or API Key could be found"
}

​
Error Codes

Common error codes returned by the API:
CodeHTTP StatusDescription
0200Success
api400Bad Request - Invalid parameters
session401Unauthorized - Invalid or missing session
access403Forbidden - Insufficient privileges
rate429Too Many Requests - Rate limit exceeded
master500Internal Error - Must be called on primary conductor

​
HTTP Methods

The API supports two HTTP methods:
  • GET: For simple queries without a request body
  • POST: For operations with JSON request bodies
Most create, update, and delete operations require POST requests with JSON bodies.

​
Content Type

All POST requests must include the Content-Type header: 
Content-Type: application/json
For file uploads, use multipart/form-data instead.

​
Master Server Requirement

Most write operations must be directed to the primary conductor server. If you call a write API on a satellite server, you may receive a redirect or error response: 
{
  "code": "master",
  "host": "primary.example.com",
  "description": "This API call can only be invoked on the primary conductor server."
}

​
Next Steps

Authentication

Learn how to authenticate API requests

Events API

Create and manage scheduled events

Jobs API

Launch and monitor job execution

Servers API

Manage server inventory

Build docs developers (and LLMs) love

Get started for freeTalk to us