Sign in
operations

Get operation details

Retrieve the full details of an operation by ID, including its current status and all dependency details. Use this to poll for operation completion after initiating a change.

get/operations/{id}

Path parameters

idstring required
Example:op-a1b2c3d4-e5f6-7890-abcd-ef1234567890

Operation ID (format: op-<uuid>)

Response

Operation details

@type'unstoppabledomains.com/partner.v3.Operation' required
idstring required

Operation ID

status'PREVIEW' | 'QUEUED' | 'PROCESSING' | 'FAILED' | 'COMPLETED' | 'CANCELLED' | 'AWAITING_UPDATES' required
type'ADMIN_GENERIC' | 'DOMAIN_ADMIN_UPDATE' | 'DOMAIN_RENEW' | 'ACCOUNT_UPDATE' | 'DOMAIN_DNS_RECORD_CREATE' | 'DOMAIN_DNS_RECORD_UPDATE' | 'DOMAIN_DNS_RECORD_DELETE' | 'DOMAIN_DNS_RECORD_BATCH' | 'DOMAIN_DNS_SECURITY_ENABLE' | 'DOMAIN_DNS_SECURITY_DELETE' | 'DOMAIN_DNS_NAME_SERVER_UPDATE' | 'DOMAIN_HOSTING_UPDATE' | 'DOMAIN_HOSTING_DISABLE' | 'DOMAIN_TRANSFER_OUT' | 'DOMAIN_TRANSFER_OUT_TOGGLE' | 'DOMAIN_FLAGS_UPDATE' | 'DOMAIN_CONTACTS_UPDATE' | 'CONTACT_CREATE' | 'DOMAIN_SUGGESTION_CREATE' | 'DOMAIN_SUGGESTION_REFRESH' | 'DOMAIN_ADMIN_DNS_ZONE_MIGRATE' required
domainstring
createdAtTimestampnumber required
lastUpdatedTimestampnumber required
validUntilTimestampnumber

Example response

{
  "id": "op-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "dependencies": [
    {
      "id": "plop_abc12345-1234-1234-1234-abc123456789",
      "parameters": {
        "owner": {
          "id": "con_abc12345-1234-1234-1234-abc123456789"
        },
        "contacts": {
          "admin": {
            "id": "con_abc12345-1234-1234-1234-abc123456789"
          },
          "billing": {
            "id": "con_abc12345-1234-1234-1234-abc123456789"
          },
          "tech": {
            "id": "con_abc12345-1234-1234-1234-abc123456789"
          }
        },
        "period": 1
      }
    }
  ]
}

Changes

Changed in 2 of the 26 revisions of this API.136

  • 64f751be432d15See the full diff
    • ●

      added the new DOMAIN_ADMIN_DNS_ZONE_MIGRATE enum value to the type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • acf7620da368121See the full diff
    • ▲

      added PlatformOperationDomainSetNameServers PlatformOperationDomainDnsSecuritySetDnssec PlatformOperationDomainDnsSecurityDeleteDnssec PlatformOperationDomainDnsSecurityUpdateZone to the dependencies/items/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ●

      removed the optional property suggestionJobId from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new DOMAIN_DNS_NAME_SERVER_UPDATE enum value to the type response property for the response status 200

      response-property-enum-value-added

    • ○

      added DOMAIN_SET_NAMESERVERS DOMAIN_DNS_SECURITY_SET_DNSSEC DOMAIN_DNS_SECURITY_DELETE_DNSSEC DOMAIN_DNS_SECURITY_UPDATE_ZONE discriminator mapping keys to the dependencies/items/ response property for the response status 200

      response-property-discriminator-mapping-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog