API Governance

API Versioning & Deprecation Policy

API Test Lab provides predictable, stable programmatic APIs for continuous integration pipelines, CLI tools, and AI agents. This policy outlines how we version endpoints, announce changes, and retire legacy interfaces.

URL Versioning

All major programmatic changes are published under explicit path versions (e.g., /api/v1/...).

90-Day Minimum Notice

We provide at least 90 calendar days advance notice before sunsetting any versioned public endpoint.

RFC 8594 Standard

Standard HTTP Deprecation and Sunset headers accompany deprecated responses.

Deprecation Lifecycle & Headers

1. Active Status

Endpoints operate with zero deprecation warnings and receive regular feature, performance, and security updates.

2. Deprecated Status (90-Day Transition Window)

When an endpoint is superseded, it enters a 90-day deprecation window. During this phase, the endpoint continues functioning normally, but includes standard IETF RFC 8594 response headers:

Deprecation: "Sun, 01 Nov 2026 00:00:00 GMT"
Sunset: "Sun, 31 Jan 2027 23:59:59 GMT"
Link: <https://api.apitestlab.org/api/v2/requests/execute>; rel="successor-version"

3. Sunset & Retirement (HTTP 410 Gone)

After the sunset timestamp has passed, the endpoint stops processing requests and returns a structured 410 Gone JSON response:

HTTP/1.1 410 Gone
Content-Type: application/json

{
  "error": "Endpoint Sunset",
  "message": "This endpoint was retired on 2027-01-31. Please migrate to /api/v2/requests/execute.",
  "migration_guide": "https://www.apitestlab.org/docs"
}

Need migration guidance or have questions?

Check our live OpenAPI specification or contact API engineering.

OpenAPI Spec

Documentation · llms.txt · Home