Sign in

v1

latestSwagger 2.02026-07-136573327.3 KB
Domains

Retrieve a list of upcoming system Maintenances

get/v2/domains/maintenances

Query parameters

status'ACTIVE' | 'CANCELLED'

Only include results with the selected status value. Returns all results if omitted<br/><ul><li><strong style='margin-left: 12px;'>ACTIVE</strong> - The upcoming maintenance is active.</li><li><strong style='margin-left: 12px;'>CANCELLED</strong> - The upcoming maintenance has been cancelled.</li></ul>

modifiedAtAfterstring iso-datetime

Only include results with modifiedAt after the supplied date

startsAtAfterstring iso-datetime

Only include results with startsAt after the supplied date

limitinteger

Maximum number of results to return

Headers

X-Request-Idstring

A client provided identifier for tracking this request.

Response

Request was successful

createdAtstring iso-datetime required

Date and time (UTC) when this maintenance was created

endsAtstring iso-datetime required

Date and time (UTC) when this maintenance will complete

environment'OTE' | 'PRODUCTION' required

The environment on which the maintenance will be performed<br/><ul><li><strong style='margin-left: 12px;'>OTE</strong> - The Operational Testing Environment.</li><li><strong style='margin-left: 12px;'>PRODUCTION</strong> - The Live Production Environment.</li></ul>

maintenanceIdstring required

The identifier for the system maintenance

modifiedAtstring iso-datetime required

Date and time (UTC) when this maintenance was last modified

reason'EMERGENCY' | 'PLANNED' required

The reason for the maintenance being performed<br/><ul><li><strong style='margin-left: 12px;'>EMERGENCY</strong> - Unexpected Emergency maintenance.</li><li><strong style='margin-left: 12px;'>PLANNED</strong> - Planned system maintenance.</li></ul>

startsAtstring iso-datetime required

Date and time (UTC) when this maintenance will start

status'ACTIVE' | 'CANCELLED' required

The status of maintenance<br/><ul><li><strong style='margin-left: 12px;'>ACTIVE</strong> - The upcoming maintenance is active.</li><li><strong style='margin-left: 12px;'>CANCELLED</strong> - The upcoming maintenance has been cancelled.</li></ul>

summarystring required

A brief description of what is being performed

tldsstring[]

List of tlds that are in maintenance. Generally only applies when type is REGISTRY

type'API' | 'REGISTRY' | 'UI' required

The type of maintenance being performed<br/><ul><li><strong style='margin-left: 12px;'>API</strong> - Programmatic Api components.</li><li><strong style='margin-left: 12px;'>REGISTRY</strong> - The underlying Registry providing the tld(s).</li><li><strong style='margin-left: 12px;'>UI</strong> - User Interface components.</li></ul>