v1

latestSwagger 2.02026-07-136573327.3 KB

Domains

Retrieve the details for an upcoming system Maintenances

get/v2/domains/maintenances/{maintenanceId}

Path parameters

maintenanceIdstring required

The identifier for the system maintenance

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 <ul><li>OTE - The Operational Testing Environment.</li><li>PRODUCTION - 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 <ul><li>EMERGENCY - Unexpected Emergency maintenance.</li><li>PLANNED - 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 <ul><li>ACTIVE - The upcoming maintenance is active.</li><li>CANCELLED - 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 <ul><li>API - Programmatic Api components.</li><li>REGISTRY - The underlying Registry providing the tld(s).</li><li>UI - User Interface components.</li></ul>