{
"openapi": "3.1.2",
"info": {
"title": "ZoneWatcher API Docs",
"version": "v1",
"description": "The ZoneWatcher API Documentation"
},
"servers": [
{
"url": "https:\/\/api.zonewatcher.com\/api"
}
],
"tags": [
{
"name": "Authentication"
},
{
"name": "Certificates"
},
{
"name": "Checks"
},
{
"name": "IP Addresses"
},
{
"name": "Prospects"
},
{
"name": "Providers"
},
{
"name": "Records"
},
{
"name": "Changesets"
},
{
"name": "Teams"
},
{
"name": "Users"
},
{
"name": "Whois"
},
{
"name": "Zones"
}
],
"security": [
{
"http": []
}
],
"paths": {
"\/me": {
"get": {
"operationId": "me",
"description": "This endpoint returns information about the currently authenticated API token.",
"summary": "Current Token",
"tags": [
"Authentication"
],
"responses": {
"200": {
"description": "`PersonalAccessTokenResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#\/components\/schemas\/PersonalAccessTokenResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
}
}
}
},
"\/certificates": {
"get": {
"operationId": "certificates.index",
"description": "This endpoint retrieves a paginated list of certificates associated with the current user's zones.\nSupports filtering and sorting via query parameters.",
"summary": "List Certificates",
"tags": [
"Certificates"
],
"responses": {
"200": {
"description": "Array of `CertificateResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#\/components\/schemas\/CertificateResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/certificates\/{certificate}": {
"get": {
"operationId": "certificates.show",
"description": "This endpoint retrieves the details of a single certificate.",
"summary": "Certificate Details",
"tags": [
"Certificates"
],
"parameters": [
{
"name": "certificate",
"in": "path",
"required": true,
"description": "The certificate prefixed id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`CertificateResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#\/components\/schemas\/CertificateResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/records\/{record}\/revert": {
"post": {
"operationId": "records.revert",
"description": "Creates a changeset to revert a record to its state at a specific check.",
"summary": "Revert Record to Version",
"tags": [
"Changesets"
],
"parameters": [
{
"name": "record",
"in": "path",
"required": true,
"description": "The record prefixed id",
"schema": {
"type": [
"string",
"null"
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/RevertRecordRequest"
}
}
}
},
"responses": {
"201": {
"description": "`ChangesetResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#\/components\/schemas\/ChangesetResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/changesets": {
"get": {
"operationId": "changesets.index",
"description": "This endpoint retrieves a paginated list of changesets for the current team.\nSupports filtering and sorting via query parameters.",
"summary": "List Changesets",
"tags": [
"Changesets"
],
"responses": {
"200": {
"description": "Array of `ChangesetResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#\/components\/schemas\/ChangesetResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
},
"post": {
"operationId": "changesets.store",
"description": "This endpoint creates a new changeset for the specified zone.",
"summary": "Create Changeset",
"tags": [
"Changesets"
],
"requestBody": {
"required": true,
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/CreateChangesetRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application\/json": {
"schema": {
"type": "integer",
"const": 201
}
}
}
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/changesets\/{changeset}": {
"get": {
"operationId": "changesets.show",
"description": "This endpoint retrieves the details of a single changeset, including its items.",
"summary": "Changeset Details",
"tags": [
"Changesets"
],
"parameters": [
{
"name": "changeset",
"in": "path",
"required": true,
"description": "The changeset ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`ChangesetResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#\/components\/schemas\/ChangesetResource"
},
{
"type": "object",
"required": [
"items"
]
}
]
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
},
"put": {
"operationId": "changesets.update",
"description": "This endpoint updates a changeset. Only draft changesets can be updated.",
"summary": "Update Changeset",
"tags": [
"Changesets"
],
"parameters": [
{
"name": "changeset",
"in": "path",
"required": true,
"description": "The changeset ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/UpdateChangesetRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ChangesetResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#\/components\/schemas\/ChangesetResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
},
"delete": {
"operationId": "changesets.destroy",
"description": "This endpoint deletes a changeset. Only draft changesets can be deleted.",
"summary": "Delete Changeset",
"tags": [
"Changesets"
],
"parameters": [
{
"name": "changeset",
"in": "path",
"required": true,
"description": "The changeset ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/changesets\/{changeset}\/items": {
"post": {
"operationId": "changesets.items.store",
"description": "This endpoint adds an item to a draft changeset.",
"summary": "Add Item to Changeset",
"tags": [
"Changesets"
],
"parameters": [
{
"name": "changeset",
"in": "path",
"required": true,
"description": "The changeset ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/AddChangesetItemRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application\/json": {
"schema": {
"type": "integer",
"const": 201
}
}
}
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/changesets\/{changeset}\/items\/{changesetItem}": {
"delete": {
"operationId": "changesets.items.destroy",
"description": "This endpoint removes an item from a draft changeset.",
"summary": "Remove Item from Changeset",
"tags": [
"Changesets"
],
"parameters": [
{
"name": "changeset",
"in": "path",
"required": true,
"description": "The changeset ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "changesetItem",
"in": "path",
"required": true,
"description": "The changeset item ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/changesets\/{changeset}\/submit": {
"post": {
"operationId": "changesets.submit",
"description": "This endpoint submits a draft changeset for review.",
"summary": "Submit Changeset",
"tags": [
"Changesets"
],
"parameters": [
{
"name": "changeset",
"in": "path",
"required": true,
"description": "The changeset ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`ChangesetResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#\/components\/schemas\/ChangesetResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/changesets\/{changeset}\/validate": {
"post": {
"operationId": "changesets.validate",
"description": "This endpoint performs local and provider-level validation on a changeset\nwithout submitting it.",
"summary": "Validate Changeset (Dry Run)",
"tags": [
"Changesets"
],
"parameters": [
{
"name": "changeset",
"in": "path",
"required": true,
"description": "The changeset ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application\/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"valid": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"item_id": {
"type": "string"
},
"message": {
"type": "string"
},
"provider_error": {
"type": "null"
}
},
"required": [
"item_id",
"message",
"provider_error"
]
},
{
"type": "object",
"properties": {
"item_id": {
"type": "string"
},
"message": {
"type": "string"
},
"provider_error": {
"type": "string"
}
},
"required": [
"item_id",
"message",
"provider_error"
]
},
{
"type": "null"
}
]
}
}
},
"required": [
"valid",
"errors"
]
},
{
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"valid",
"errors"
]
}
]
}
}
}
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/changesets\/{changeset}\/request-approval": {
"post": {
"operationId": "changesets.request-approval",
"description": "This endpoint requests approval for a submitted changeset.",
"summary": "Request Approval",
"tags": [
"Changesets"
],
"parameters": [
{
"name": "changeset",
"in": "path",
"required": true,
"description": "The changeset ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/RequestApprovalRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ChangesetResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#\/components\/schemas\/ChangesetResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/changesets\/{changeset}\/approve": {
"post": {
"operationId": "changesets.approve",
"description": "This endpoint approves a changeset that is pending approval.",
"summary": "Approve Changeset",
"tags": [
"Changesets"
],
"parameters": [
{
"name": "changeset",
"in": "path",
"required": true,
"description": "The changeset ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/ApproveChangesetRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ChangesetResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#\/components\/schemas\/ChangesetResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/changesets\/{changeset}\/reject": {
"post": {
"operationId": "changesets.reject",
"description": "This endpoint rejects a changeset that is pending approval.",
"summary": "Reject Changeset",
"tags": [
"Changesets"
],
"parameters": [
{
"name": "changeset",
"in": "path",
"required": true,
"description": "The changeset ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/RejectChangesetRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ChangesetResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#\/components\/schemas\/ChangesetResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/changesets\/{changeset}\/retry": {
"post": {
"operationId": "changesets.retry",
"description": "Retries a failed changeset by resetting failed items and re-dispatching the apply job.",
"summary": "Retry Changeset",
"tags": [
"Changesets"
],
"parameters": [
{
"name": "changeset",
"in": "path",
"required": true,
"description": "The changeset ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`ChangesetResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#\/components\/schemas\/ChangesetResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/changesets\/{changeset}\/rollback": {
"post": {
"operationId": "changesets.rollback",
"description": "Creates a new rollback changeset that inverts the applied changes.",
"summary": "Rollback Changeset",
"tags": [
"Changesets"
],
"parameters": [
{
"name": "changeset",
"in": "path",
"required": true,
"description": "The changeset ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"201": {
"description": "`ChangesetResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#\/components\/schemas\/ChangesetResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/changesets\/{changeset}\/cancel": {
"post": {
"operationId": "changesets.cancel",
"description": "Cancels a changeset that has not yet been applied.",
"summary": "Cancel Changeset",
"tags": [
"Changesets"
],
"parameters": [
{
"name": "changeset",
"in": "path",
"required": true,
"description": "The changeset ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/CancelChangesetRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ChangesetResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#\/components\/schemas\/ChangesetResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/zones\/{zone}\/changesets": {
"get": {
"operationId": "zones.changesets.index",
"description": "This endpoint retrieves a paginated list of changesets for a specific zone.",
"summary": "List Zone Changesets",
"tags": [
"Changesets"
],
"parameters": [
{
"name": "zone",
"in": "path",
"required": true,
"description": "The zone prefixed id",
"schema": {
"type": [
"string",
"null"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `ChangesetResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#\/components\/schemas\/ChangesetResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"next_cursor": {
"type": [
"string",
"null"
],
"description": "The \"cursor\" that points to the next set of items."
},
"prev_cursor": {
"type": [
"string",
"null"
],
"description": "The \"cursor\" that points to the previous set of items."
}
},
"required": [
"path",
"per_page",
"next_cursor",
"prev_cursor"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
}
}
}
},
"\/zones\/{zone}\/revert-to-check": {
"post": {
"operationId": "zones.revert-to-check",
"description": "Creates a changeset to revert a zone to its state at a specific check.",
"summary": "Revert Zone to Check",
"tags": [
"Changesets"
],
"parameters": [
{
"name": "zone",
"in": "path",
"required": true,
"description": "The zone prefixed id",
"schema": {
"type": [
"string",
"null"
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/RevertZoneToCheckRequest"
}
}
}
},
"responses": {
"201": {
"description": "`ChangesetResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#\/components\/schemas\/ChangesetResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/checks": {
"get": {
"operationId": "checks.index",
"description": "This endpoint retrieves a paginated list of checks associated with the current user's zones.\nSupports filtering and sorting via query parameters.",
"summary": "List Checks",
"tags": [
"Checks"
],
"responses": {
"200": {
"description": "Array of `CheckResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#\/components\/schemas\/CheckResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/checks\/{check}": {
"get": {
"operationId": "checks.show",
"description": "This endpoint retrieves the details of a specific check.",
"summary": "Check Details",
"tags": [
"Checks"
],
"parameters": [
{
"name": "check",
"in": "path",
"required": true,
"description": "The check prefixed id",
"schema": {
"type": [
"string",
"null"
]
}
}
],
"responses": {
"200": {
"description": "`CheckResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#\/components\/schemas\/CheckResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/ip-addresses\/{ipAddress}": {
"get": {
"operationId": "ip-addresses.show",
"description": "This endpoint retrieves detailed information about a specific IP address.",
"summary": "IP Address Details",
"tags": [
"IP Addresses"
],
"parameters": [
{
"name": "ipAddress",
"in": "path",
"required": true,
"description": "The ip address prefixed id",
"schema": {
"type": [
"string",
"null"
]
}
}
],
"responses": {
"200": {
"description": "`IpAddressResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#\/components\/schemas\/IpAddressResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
}
}
}
},
"\/prospects": {
"get": {
"operationId": "prospects.index",
"description": "This endpoint retrieves a paginated list of prospects associated with the current user.\nSupports filtering and sorting via query parameters.",
"summary": "List Prospects",
"tags": [
"Prospects"
],
"responses": {
"200": {
"description": "Array of `ProspectResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#\/components\/schemas\/ProspectResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/prospects\/{prospect}": {
"get": {
"operationId": "prospects.show",
"description": "This endpoint retrieves the details of a single prospect.",
"summary": "Prospect Details",
"tags": [
"Prospects"
],
"parameters": [
{
"name": "prospect",
"in": "path",
"required": true,
"description": "The prospect prefixed id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`ProspectResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#\/components\/schemas\/ProspectResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/providers": {
"get": {
"operationId": "providers.index",
"description": "This endpoint retrieves a paginated list of providers associated with the current user.\nSupports filtering and sorting via query parameters.",
"summary": "List Providers",
"tags": [
"Providers"
],
"responses": {
"200": {
"description": "Array of `ProviderResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#\/components\/schemas\/ProviderResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/providers\/{provider}": {
"get": {
"operationId": "providers.show",
"description": "This endpoint retrieves the details of a single provider.",
"summary": "Provider Details",
"tags": [
"Providers"
],
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"description": "The provider prefixed id",
"schema": {
"type": [
"string",
"null"
]
}
}
],
"responses": {
"200": {
"description": "`ProviderResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#\/components\/schemas\/ProviderResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/records": {
"get": {
"operationId": "records.index",
"description": "This endpoint retrieves a paginated list of records associated with the current user's zones.\nSupports filtering and sorting via query parameters.",
"summary": "List Records",
"tags": [
"Records"
],
"responses": {
"200": {
"description": "Array of `RecordResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#\/components\/schemas\/RecordResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/records\/{record}": {
"get": {
"operationId": "records.show",
"description": "This endpoint retrieves the details of a single record.",
"summary": "Record Details",
"tags": [
"Records"
],
"parameters": [
{
"name": "record",
"in": "path",
"required": true,
"description": "The record prefixed id",
"schema": {
"type": [
"string",
"null"
]
}
}
],
"responses": {
"200": {
"description": "`RecordResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#\/components\/schemas\/RecordResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/teams": {
"get": {
"operationId": "teams.index",
"description": "This endpoint retrieves a paginated list of teams associated with the current user.\nSupports filtering and sorting via query parameters.",
"summary": "List Teams",
"tags": [
"Teams"
],
"responses": {
"200": {
"description": "Array of `TeamResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#\/components\/schemas\/TeamResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/teams\/{team}": {
"get": {
"operationId": "teams.show",
"description": "This endpoint retrieves the details of a single team.",
"summary": "Team Details",
"tags": [
"Teams"
],
"parameters": [
{
"name": "team",
"in": "path",
"required": true,
"description": "The team prefixed id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`TeamResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#\/components\/schemas\/TeamResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/users": {
"get": {
"operationId": "users.index",
"description": "This endpoint retrieves a paginated list of users associated with the current team.\nSupports filtering and sorting via query parameters.",
"summary": "List Users",
"tags": [
"Users"
],
"responses": {
"200": {
"description": "Array of `UserResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#\/components\/schemas\/UserResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/users\/{user}": {
"get": {
"operationId": "users.show",
"description": "This endpoint retrieves the details of a single user.",
"summary": "User Details",
"tags": [
"Users"
],
"parameters": [
{
"name": "user",
"in": "path",
"required": true,
"description": "The user prefixed id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`UserResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#\/components\/schemas\/UserResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/whois": {
"get": {
"operationId": "whois.index",
"description": "This endpoint retrieves a paginated list of whois records associated with the current user's zones.\nSupports filtering and sorting via query parameters.",
"summary": "List Whois Records",
"tags": [
"Whois"
],
"responses": {
"200": {
"description": "Array of `WhoisResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#\/components\/schemas\/WhoisResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/zones": {
"get": {
"operationId": "zones.index",
"description": "This endpoint retrieves a paginated list of zones associated with the current team.\nSupports filtering and sorting via query parameters.",
"summary": "List Zones",
"tags": [
"Zones"
],
"responses": {
"200": {
"description": "Array of `ZoneResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#\/components\/schemas\/ZoneResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
},
"post": {
"operationId": "zones.store",
"description": "This endpoint creates a new zone (Public DNS or AXFR) for the specified provider.\nThe provider must support zone creation (PUBLIC_DNS or AXFR_PROTOCOL vendors only).",
"summary": "Create Zone",
"tags": [
"Zones"
],
"requestBody": {
"required": true,
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/CreateZoneRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application\/json": {
"schema": {
"type": "integer",
"const": 201
}
}
}
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/zones\/{zone}": {
"get": {
"operationId": "zones.show",
"description": "This endpoint retrieves the details of a single zone.",
"summary": "Zone Details",
"tags": [
"Zones"
],
"parameters": [
{
"name": "zone",
"in": "path",
"required": true,
"description": "The zone prefixed id",
"schema": {
"type": [
"string",
"null"
]
}
}
],
"responses": {
"200": {
"description": "`ZoneResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#\/components\/schemas\/ZoneResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/zones\/{zone}\/similar-domains": {
"get": {
"operationId": "zones.similar-domains.index",
"description": "This endpoint retrieves a paginated list of lookalike domains recorded for a zone.\nOnly matches that meet the display threshold for their category are returned.\nSimilar domain detection must be included in the current team's plan.",
"summary": "List Zone Similar Domains",
"tags": [
"Zones"
],
"parameters": [
{
"name": "zone",
"in": "path",
"required": true,
"description": "The zone prefixed id",
"schema": {
"type": [
"string",
"null"
]
}
}
],
"responses": {
"200": {
"description": "Array of `SimilarDomainResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#\/components\/schemas\/SimilarDomainResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/zones\/{zone}\/tags": {
"put": {
"operationId": "zones.tags.sync",
"description": "Replaces the custom tags on a zone. Provider tags are left unchanged.\nA name that already exists as a provider tag on the zone is ignored.",
"summary": "Replace Custom Zone Tags",
"tags": [
"Zones"
],
"parameters": [
{
"name": "zone",
"in": "path",
"required": true,
"description": "The zone prefixed id",
"schema": {
"type": [
"string",
"null"
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/SyncZoneTagsRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ZoneResource`",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#\/components\/schemas\/ZoneResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
},
"422": {
"$ref": "#\/components\/responses\/ValidationException"
},
"403": {
"$ref": "#\/components\/responses\/AuthorizationException"
}
}
}
},
"\/sso\/enforcement\/{team}": {
"delete": {
"operationId": "sso.enforcement.destroy",
"description": "Allows the team owner to turn off `force_sso` for the specified team\nwhen the identity provider is unavailable. Requires a personal API\ntoken belonging to the team owner; non-owners receive 403.",
"summary": "Disable SSO enforcement for a team (break-glass)",
"tags": [
"DisableSsoEnforcement"
],
"parameters": [
{
"name": "team",
"in": "path",
"required": true,
"description": "The team prefixed id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application\/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"message": {
"type": "string",
"const": "SSO enforcement has been disabled."
},
"force_sso": {
"type": "boolean"
}
},
"required": [
"message",
"force_sso"
]
},
{
"type": "object",
"properties": {
"message": {
"type": "string",
"const": "SSO enforcement is not currently enabled."
},
"force_sso": {
"type": "boolean"
}
},
"required": [
"message",
"force_sso"
]
}
]
}
}
}
},
"403": {
"description": "",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"const": "Only the team owner can disable SSO enforcement."
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"$ref": "#\/components\/responses\/ModelNotFoundException"
},
"401": {
"$ref": "#\/components\/responses\/AuthenticationException"
}
}
}
}
},
"components": {
"securitySchemes": {
"http": {
"type": "http",
"scheme": "bearer"
}
},
"schemas": {
"AddChangesetItemRequest": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"create",
"update",
"delete"
]
},
"record_type": {
"type": "string",
"enum": [
""
]
},
"record_name": {
"type": "string",
"maxLength": 255
},
"record_data": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"ttl": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"priority": {
"type": [
"integer",
"null"
]
},
"provider_record_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"operation",
"record_type",
"record_name",
"record_data"
],
"title": "AddChangesetItemRequest"
},
"ApproveChangesetRequest": {
"type": "object",
"properties": {
"comment": {
"type": [
"string",
"null"
],
"maxLength": 1000
}
},
"title": "ApproveChangesetRequest"
},
"CancelChangesetRequest": {
"type": "object",
"properties": {
"reason": {
"type": [
"string",
"null"
],
"maxLength": 500
}
},
"title": "CancelChangesetRequest"
},
"CertificateResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"zone_id": {
"type": "string"
},
"issuer_ca_id": {
"type": "string"
},
"issuer_name": {
"type": "string"
},
"common_name": {
"type": "string"
},
"name_value": {
"type": "array",
"items": {}
},
"ct_id": {
"type": "string"
},
"entry_timestamp": {
"type": "string"
},
"not_before": {
"type": "string"
},
"not_after": {
"type": "string"
},
"serial_number": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"zone_id",
"issuer_ca_id",
"issuer_name",
"common_name",
"name_value",
"ct_id",
"entry_timestamp",
"not_before",
"not_after",
"serial_number",
"created_at",
"updated_at"
],
"title": "CertificateResource"
},
"ChangesetItemResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"019477a0-1234-7000-8000-000000000002"
]
},
"operation": {
"type": "string"
},
"operation_label": {
"type": "string"
},
"operation_color": {
"type": "string"
},
"record_type": {
"type": "string",
"examples": [
"A"
]
},
"record_name": {
"type": "string",
"examples": [
"www.example.com"
]
},
"record_data": {
"type": "string"
},
"ttl": {
"type": "string",
"examples": [
"300"
]
},
"priority": {
"type": "string",
"examples": [
"10"
]
},
"status": {
"type": "string"
},
"status_label": {
"type": "string"
},
"before_state": {
"type": "string"
},
"after_state": {
"type": "string"
},
"error_message": {
"type": "string"
},
"applied_at": {
"type": [
"string",
"null"
]
},
"sort_order": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"operation",
"operation_label",
"operation_color",
"record_type",
"record_name",
"record_data",
"ttl",
"priority",
"status",
"status_label",
"before_state",
"after_state",
"error_message",
"applied_at",
"sort_order",
"created_at",
"updated_at"
],
"title": "ChangesetItemResource"
},
"ChangesetResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"019477a0-1234-7000-8000-000000000001"
]
},
"zone_id": {
"type": "string",
"examples": [
"zone_XXMzClIvaZWP8V3"
]
},
"zone_domain": {
"type": "string",
"examples": [
"example.com"
]
},
"user_id": {
"type": "string",
"examples": [
"user_XXMzClIvaZWP8V3"
]
},
"title": {
"type": "string",
"examples": [
"Update DNS records"
]
},
"notes": {
"type": "string",
"examples": [
"Optional notes about this changeset"
]
},
"status": {
"type": "string"
},
"status_label": {
"type": "string"
},
"status_color": {
"type": "string"
},
"is_rollback": {
"type": "string"
},
"rollback_of_id": {
"type": "string"
},
"items_count": {
"type": "integer"
},
"approved_by": {
"type": [
"string",
"null"
],
"examples": [
"user_XXMzClIvaZWP8V3"
]
},
"scheduled_at": {
"type": [
"string",
"null"
]
},
"submitted_at": {
"type": [
"string",
"null"
]
},
"approved_at": {
"type": [
"string",
"null"
]
},
"applied_at": {
"type": [
"string",
"null"
]
},
"completed_at": {
"type": [
"string",
"null"
]
},
"verified_at": {
"type": [
"string",
"null"
]
},
"propagated_at": {
"type": [
"string",
"null"
]
},
"failed_at": {
"type": [
"string",
"null"
]
},
"rolled_back_at": {
"type": [
"string",
"null"
]
},
"cancelled_at": {
"type": [
"string",
"null"
]
},
"error_message": {
"type": "string"
},
"ai_risk_score": {
"type": "string"
},
"ai_risk_level": {
"type": "string"
},
"ai_risk_summary": {
"type": "string"
},
"ai_risk_explanation": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"items": {
"type": "array",
"items": {
"$ref": "#\/components\/schemas\/ChangesetItemResource"
}
}
},
"required": [
"id",
"zone_id",
"zone_domain",
"user_id",
"title",
"notes",
"status",
"status_label",
"status_color",
"is_rollback",
"rollback_of_id",
"approved_by",
"scheduled_at",
"submitted_at",
"approved_at",
"applied_at",
"completed_at",
"verified_at",
"propagated_at",
"failed_at",
"rolled_back_at",
"cancelled_at",
"error_message",
"ai_risk_score",
"ai_risk_level",
"ai_risk_summary",
"ai_risk_explanation",
"created_at",
"updated_at"
],
"title": "ChangesetResource"
},
"CheckResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"zone_id": {
"type": "string"
},
"type": {
"type": "string"
},
"status": {
"type": "string"
},
"changed_records_count": {
"type": "string"
},
"total_records_count": {
"type": "string"
},
"error_message": {
"type": "string"
},
"ai_risk_score": {
"type": "string"
},
"ai_risk_level": {
"type": "string"
},
"ai_risk_summary": {
"type": "string"
},
"ai_risk_explanation": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"records": {
"type": "array",
"items": {
"$ref": "#\/components\/schemas\/RecordResource"
}
}
},
"required": [
"id",
"zone_id",
"type",
"status",
"changed_records_count",
"total_records_count",
"error_message",
"ai_risk_score",
"ai_risk_level",
"ai_risk_summary",
"ai_risk_explanation",
"created_at",
"updated_at"
],
"title": "CheckResource"
},
"CreateChangesetRequest": {
"type": "object",
"properties": {
"zone_id": {
"type": "string"
},
"title": {
"type": "string",
"maxLength": 255
},
"notes": {
"type": [
"string",
"null"
],
"maxLength": 5000
},
"scheduled_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"zone_id",
"title"
],
"title": "CreateChangesetRequest"
},
"CreateZoneRequest": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"pattern": "^(?!_)[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$",
"maxLength": 255
},
"provider_id": {
"type": "string"
}
},
"required": [
"domain",
"provider_id"
],
"title": "CreateZoneRequest"
},
"IpAddressResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the IP address.",
"examples": [
"ipad_nNR15wdTp17o13R"
]
},
"ip": {
"type": "string",
"description": "The IPv4 or IPv6 address.",
"examples": [
"10.1.2.3",
"2001:0db8:85a3:0000:0000:8a2e:0370:7334"
]
},
"type": {
"type": "string",
"description": "The type of the IP address (e.g., IPv4, IPv6)."
},
"country_code": {
"type": "string",
"description": "The country code of the IP address.",
"examples": [
"US",
"CA"
]
},
"region_code": {
"type": "string",
"description": "The region code of the IP address.",
"examples": [
"OH",
"TX"
]
},
"city": {
"type": "string",
"description": "The city name of the IP address.",
"examples": [
"Austin"
]
},
"latitude": {
"type": "string",
"description": "The approximate latitude of the IP address.",
"examples": [
"30.2672"
]
},
"longitude": {
"type": "string",
"description": "The approximate longitude of the IP address.",
"examples": [
"-97.7431"
]
},
"timezone": {
"type": "string",
"description": "The timezone of the IP address.",
"examples": [
"America\/Chicago"
]
},
"asn": {
"type": "string",
"description": "The Autonomous System Number (ASN) associated with the IP address.",
"examples": [
"AS13335"
]
},
"as_name": {
"type": "string",
"description": "The name of the Autonomous System (AS) associated with the IP address.",
"examples": [
"CLOUDFLARENET"
]
},
"isp": {
"type": "string",
"description": "The organization associated with the IP address.",
"examples": [
"Cloudflare, Inc."
]
},
"org": {
"type": "string",
"description": "The organization associated with the IP address.",
"examples": [
"Cloudflare, Inc."
]
},
"ptr": {
"type": "string",
"description": "The reverse DNS name associated with the IP address.",
"examples": [
"mx1.example.com"
]
},
"mobile": {
"type": "string",
"description": "Indicates if the IP address is mobile.",
"examples": [
true
]
},
"proxy": {
"type": "string",
"description": "Indicates if the IP address is a proxy.",
"examples": [
true
]
},
"hosting": {
"type": "string",
"description": "Indicates if the IP address is a hosting provider.",
"examples": [
true
]
},
"created_at": {
"type": "string",
"description": "When the IP address was first discovered in RFC3339 format.",
"examples": [
"2023-10-01T12:34:56+00:00"
]
},
"updated_at": {
"type": "string",
"description": "When the IP address was last updated in RFC3339 format.",
"examples": [
"2023-10-01T12:34:56+00:00"
]
}
},
"required": [
"id",
"ip",
"type",
"country_code",
"region_code",
"city",
"latitude",
"longitude",
"timezone",
"asn",
"as_name",
"isp",
"org",
"ptr",
"mobile",
"proxy",
"hosting",
"created_at",
"updated_at"
],
"title": "IpAddressResource"
},
"PersonalAccessTokenResource": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"abilities": {
"type": "string"
},
"user_id": {
"type": "string"
},
"teams": {
"type": "array",
"items": {
"$ref": "#\/components\/schemas\/TeamResource"
}
},
"expires_at": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string"
}
},
"required": [
"name",
"abilities",
"user_id",
"teams",
"expires_at",
"created_at"
],
"title": "PersonalAccessTokenResource"
},
"ProspectResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"zone_id": {
"type": "string"
},
"name": {
"type": "string"
},
"priority": {
"type": "string"
},
"record_types": {
"type": "object",
"properties": {
"A": {
"type": "string"
},
"AAAA": {
"type": "string"
},
"ANAME": {
"type": "string"
},
"AXFR": {
"type": "string"
},
"CAA": {
"type": "string"
},
"CNAME": {
"type": "string"
},
"DNSKEY": {
"type": "string"
},
"HTTPRED": {
"type": "string"
},
"MX": {
"type": "string"
},
"NS": {
"type": "string"
},
"PTR": {
"type": "string"
},
"RRSIG": {
"type": "string"
},
"SOA": {
"type": "string"
},
"SPF": {
"type": "string"
},
"SRV": {
"type": "string"
},
"TXT": {
"type": "string"
},
"URI": {
"type": "string"
}
},
"required": [
"A",
"AAAA",
"ANAME",
"AXFR",
"CAA",
"CNAME",
"DNSKEY",
"HTTPRED",
"MX",
"NS",
"PTR",
"RRSIG",
"SOA",
"SPF",
"SRV",
"TXT",
"URI"
]
},
"created_at": {
"type": [
"string",
"null"
]
},
"updated_at": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"zone_id",
"name",
"priority",
"record_types",
"created_at",
"updated_at"
],
"title": "ProspectResource"
},
"ProviderResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the provider.",
"examples": [
"prdr_5n7mNP94Iwe3WpR"
]
},
"name": {
"type": "string",
"description": "The name of the provider.",
"examples": [
"Client A Cloudflare"
]
},
"team_id": {
"type": "string",
"description": "The team ID of the provider.",
"examples": [
"team_diZP0l5QyPxz64a"
]
},
"vendor": {
"description": "The vendor of the provider.\n| |\n|---|\n| `607` Alibaba Cloud |\n| `1` Amazon Route 53 |\n| `471` Ascio |\n| `374` Atom |\n| `17` AXFR Protocol |\n| `13` Azure |\n| `29` Azure Private DNS |\n| `21` BunnyDNS |\n| `617` Civo |\n| `437` Contabo |\n| `860` CSC Global |\n| `5` Cloudflare V3 |\n| `11` Cloudflare V4 |\n| `20` ClouDNS |\n| `253` deSEC |\n| `3` Digital Ocean |\n| `7` DNS Made Easy |\n| `15` DNSimple |\n| `30` DreamHost |\n| `10` Dummy |\n| `527` Dynadot |\n| `665` EasyDNS |\n| `32` eNom |\n| `347` Gandi |\n| `856` Gcore |\n| `6` GoDaddy (legacy v1 API, sso-key credentials) |\n| `861` GoDaddy (v3 API, Personal Access Token) |\n| `2` Google Cloud |\n| `18` Hetzner |\n| `456` Hostinger |\n| `834` Huawei Cloud |\n| `23` IBM Cloud |\n| `31` Interserver |\n| `862` INWX |\n| `22` IONOS |\n| `33` Katapult |\n| `427` LeaseWeb |\n| `12` Linode V4 |\n| `858` MarkMonitor |\n| `26` Namecheap |\n| `27` NameDotCom |\n| `28` NameSilo |\n| `857` Netlify |\n| `473` No-IP |\n| `8` NS1 |\n| `24` Oracle Cloud |\n| `188` OVH |\n| `25` Porkbun |\n| `482` PowerDNS |\n| `9` Public DNS |\n| `144` Rackspace |\n| `19` Scaleway |\n| `371` Digicert UltraDNS |\n| `859` Spaceship |\n| `824` Vercel |\n| `16` Vultr |\n| `742` Wix |",
"$ref": "#\/components\/schemas\/ProviderVendor"
},
"status": {
"description": "The current status of the provider.",
"$ref": "#\/components\/schemas\/ProviderStatus"
},
"failed_counter": {
"type": "string",
"description": "The number of consecutive failures when attempting to sync the provider.",
"examples": [
"0",
"1"
]
},
"last_synced_at": {
"type": "string",
"description": "The last time the provider was synced.",
"examples": [
"2025-03-01T00:00:00+00:00"
]
},
"snoozed_until": {
"type": "string",
"description": "The time the provider notifications are snoozed until.",
"examples": [
"2025-03-01T00:00:00+00:00"
]
},
"created_at": {
"type": "string",
"description": "The date and time the provider was created.",
"examples": [
"2025-03-01T00:00:00+00:00"
]
},
"updated_at": {
"type": "string",
"description": "The date and time the provider was last updated.",
"examples": [
"2025-03-01T00:00:00+00:00"
]
}
},
"required": [
"id",
"name",
"team_id",
"vendor",
"status",
"failed_counter",
"last_synced_at",
"snoozed_until",
"created_at",
"updated_at"
],
"title": "ProviderResource"
},
"ProviderStatus": {
"type": "integer",
"enum": [
100,
110,
199,
200,
221,
222,
299,
300,
399,
400,
410,
411,
415,
420,
421,
430,
499,
600,
610,
620,
621,
623,
629,
699,
700,
751,
752,
753,
754,
755,
799
],
"title": "ProviderStatus"
},
"ProviderVendor": {
"type": "integer",
"description": "| |\n|---|\n| `607` Alibaba Cloud |\n| `1` Amazon Route 53 |\n| `471` Ascio |\n| `374` Atom |\n| `17` AXFR Protocol |\n| `13` Azure |\n| `29` Azure Private DNS |\n| `21` BunnyDNS |\n| `617` Civo |\n| `437` Contabo |\n| `860` CSC Global |\n| `5` Cloudflare V3 |\n| `11` Cloudflare V4 |\n| `20` ClouDNS |\n| `253` deSEC |\n| `3` Digital Ocean |\n| `7` DNS Made Easy |\n| `15` DNSimple |\n| `30` DreamHost |\n| `10` Dummy |\n| `527` Dynadot |\n| `665` EasyDNS |\n| `32` eNom |\n| `347` Gandi |\n| `856` Gcore |\n| `6` GoDaddy (legacy v1 API, sso-key credentials) |\n| `861` GoDaddy (v3 API, Personal Access Token) |\n| `2` Google Cloud |\n| `18` Hetzner |\n| `456` Hostinger |\n| `834` Huawei Cloud |\n| `23` IBM Cloud |\n| `31` Interserver |\n| `862` INWX |\n| `22` IONOS |\n| `33` Katapult |\n| `427` LeaseWeb |\n| `12` Linode V4 |\n| `858` MarkMonitor |\n| `26` Namecheap |\n| `27` NameDotCom |\n| `28` NameSilo |\n| `857` Netlify |\n| `473` No-IP |\n| `8` NS1 |\n| `24` Oracle Cloud |\n| `188` OVH |\n| `25` Porkbun |\n| `482` PowerDNS |\n| `9` Public DNS |\n| `144` Rackspace |\n| `19` Scaleway |\n| `371` Digicert UltraDNS |\n| `859` Spaceship |\n| `824` Vercel |\n| `16` Vultr |\n| `742` Wix |",
"enum": [
607,
1,
471,
374,
17,
13,
29,
21,
617,
437,
860,
5,
11,
20,
253,
3,
7,
15,
30,
10,
527,
665,
32,
347,
856,
6,
861,
2,
18,
456,
834,
23,
31,
862,
22,
33,
427,
12,
858,
26,
27,
28,
857,
473,
8,
24,
188,
25,
482,
9,
144,
19,
371,
859,
824,
16,
742
],
"title": "ProviderVendor"
},
"RecordResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the record.",
"examples": [
"rcrd_TJiEWEDDtMg2eg8"
]
},
"zone_id": {
"type": "string",
"description": "The ID of the zone the record belongs to.",
"examples": [
"zone_SL0igWo9EhbKsif"
]
},
"vendor_uuid": {
"type": "string",
"description": "The UUID of the vendor.",
"examples": [
"4c1f2b8e-3d7a-4f5b-8c6d-0e9f1a2b3c4d",
null
]
},
"name": {
"type": "string",
"description": "The name of the record.",
"examples": [
"www",
"@",
"_sip._tcp"
]
},
"type": {
"type": "string",
"description": "The type of the record."
},
"class": {
"type": "string",
"description": "The class of the record."
},
"rdata": {
"type": "string",
"description": "The data of the record.",
"examples": [
[
"127.0.0.1"
]
]
},
"ttl": {
"type": "string",
"description": "The TTL (Time to Live) of the record in seconds.",
"examples": [
"3600"
]
},
"priority": {
"type": "string",
"description": "The priority of the record. (optional based on the type)",
"examples": [
"10"
]
},
"weight": {
"type": "string",
"description": "The weight of the record. (optional based on the type)",
"examples": [
"10"
]
},
"port": {
"type": "string",
"description": "The port of the record. (optional based on the type)",
"examples": [
"80"
]
},
"service": {
"type": "string",
"description": "The service of the record. (optional based on the type)",
"examples": [
"_http"
]
},
"protocol": {
"type": "string",
"description": "The protocol of the record. (optional based on the type)",
"examples": [
"_tcp"
]
},
"ip_address_id": {
"type": [
"string",
"null"
],
"description": "The ID of the IP address associated with the record. (optional based on the type)",
"examples": [
"ipad_xyZV32ajXgeO9zU"
]
},
"comment": {
"type": "string",
"description": "The comment associated with the record. (optional based on provider support)",
"examples": [
"This is a comment",
null
]
},
"cdn": {
"type": "string",
"description": "The CDN (Content Delivery Network) associated with the record. (only for Public DNS)"
},
"sha1": {
"type": "string",
"description": "The SHA1 hash of the record.",
"examples": [
"74fc317b2247e17e5183f4b1955b9784ed1501c6"
]
},
"last_found_at": {
"type": [
"string",
"null"
],
"description": "The last found date of the record.",
"examples": [
"2025-03-01T00:00:00+00:00"
]
},
"created_at": {
"type": "string",
"description": "The date the record was added to ZoneWatcher.",
"examples": [
"2025-03-01T00:00:00+00:00"
]
},
"updated_at": {
"type": "string",
"description": "The date the record was last updated in ZoneWatcher.",
"examples": [
"2025-03-01T00:00:00+00:00"
]
}
},
"required": [
"id",
"zone_id",
"vendor_uuid",
"name",
"type",
"class",
"rdata",
"ttl",
"priority",
"weight",
"port",
"service",
"protocol",
"ip_address_id",
"comment",
"cdn",
"sha1",
"last_found_at",
"created_at",
"updated_at"
],
"title": "RecordResource"
},
"RejectChangesetRequest": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"maxLength": 1000
},
"action": {
"type": [
"string",
"null"
],
"enum": [
"return_to_draft",
"cancel",
null
]
}
},
"required": [
"comment"
],
"title": "RejectChangesetRequest"
},
"RequestApprovalRequest": {
"type": "object",
"properties": {
"approver_id": {
"type": [
"integer",
"null"
]
},
"message": {
"type": [
"string",
"null"
],
"maxLength": 1000
}
},
"title": "RequestApprovalRequest"
},
"RevertRecordRequest": {
"type": "object",
"properties": {
"check_id": {
"type": "integer"
}
},
"required": [
"check_id"
],
"title": "RevertRecordRequest"
},
"RevertZoneToCheckRequest": {
"type": "object",
"properties": {
"check_id": {
"type": "integer"
}
},
"required": [
"check_id"
],
"title": "RevertZoneToCheckRequest"
},
"SimilarDomainResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the similar domain.",
"examples": [
"4c1f2b8e-3d7a-4f5b-8c6d-0e9f1a2b3c4d"
]
},
"watched_domain": {
"type": "string",
"description": "The watched domain this lookalike was matched against.",
"examples": [
"example.com"
]
},
"matched_domain": {
"type": "string",
"description": "The lookalike domain.",
"examples": [
"examp1e.com"
]
},
"category": {
"type": [
"string",
"null"
],
"description": "The kind of similarity. One of tld_swap, homoglyph, dash_variant, typo, fuzzy, or combosquat.",
"examples": [
"typo"
]
},
"tld": {
"type": "string",
"description": "The top-level domain of the lookalike.",
"examples": [
"com"
]
},
"score": {
"type": "string",
"description": "Similarity from 0 to 1. A score of 0.875 is 87.5% similar.",
"examples": [
"0.875"
]
},
"first_found_at": {
"type": "string",
"description": "When this lookalike was first recorded.",
"examples": [
"2026-03-01T12:00:00+00:00"
]
},
"last_found_at": {
"type": "string",
"description": "When this lookalike was most recently recorded.",
"examples": [
"2026-03-02T15:30:00+00:00"
]
},
"created_at": {
"type": "string",
"description": "When the similar domain record was created.",
"examples": [
"2026-04-01T00:00:00+00:00"
]
},
"updated_at": {
"type": "string",
"description": "When the similar domain record was last updated.",
"examples": [
"2026-04-01T00:00:00+00:00"
]
}
},
"required": [
"id",
"watched_domain",
"matched_domain",
"category",
"tld",
"score",
"first_found_at",
"last_found_at",
"created_at",
"updated_at"
],
"title": "SimilarDomainResource"
},
"SyncZoneTagsRequest": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\p{L}\\p{N}][\\p{L}\\p{N} _.:\\\/=@+-]{0,63}$",
"maxLength": 64
}
}
},
"required": [
"tags"
],
"title": "SyncZoneTagsRequest"
},
"TeamResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"trial_ends_at": {
"type": [
"string",
"null"
]
},
"billing": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string"
},
"address_line_2": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"country": {
"type": "string"
},
"vat_id": {
"type": "string"
},
"invoice_emails": {
"type": "string"
}
},
"required": [
"address_line_1",
"address_line_2",
"city",
"state",
"postal_code",
"country",
"vat_id",
"invoice_emails"
]
},
"snoozed_until": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"name",
"trial_ends_at",
"billing",
"snoozed_until",
"created_at",
"updated_at"
],
"title": "TeamResource"
},
"UpdateChangesetRequest": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 255
},
"notes": {
"type": [
"string",
"null"
],
"maxLength": 5000
},
"scheduled_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"title": "UpdateChangesetRequest"
},
"UserResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"email_verified_at": {
"type": [
"string",
"null"
]
},
"timezone": {
"type": "string"
},
"two_factor_enabled": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"name",
"email",
"email_verified_at",
"timezone",
"two_factor_enabled",
"created_at",
"updated_at"
],
"title": "UserResource"
},
"WhoisResource": {
"type": "array",
"items": {},
"title": "WhoisResource"
},
"ZoneResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the zone.",
"examples": [
"zone_XXMzClIvaZWP8V3"
]
},
"domain": {
"type": "string",
"description": "The domain name of the zone.",
"examples": [
"example.com"
]
},
"domain_reversed": {
"type": "string",
"description": "The reversed domain name of the zone.",
"examples": [
"com.example"
]
},
"status": {
"type": "string",
"description": "The status of the zone."
},
"provider_id": {
"type": "string",
"description": "The provider ID of the zone."
},
"failed_counter": {
"type": "string",
"description": "The number of consecutive failures when attempting to check the zone.",
"examples": [
"0",
"1"
]
},
"failed_whois_counter": {
"type": "string",
"description": "The number of consecutive failures when attempting to check the WHOIS information of the zone.",
"examples": [
"0",
"1"
]
},
"lifetime_checks": {
"type": "string",
"description": "The total number of checks performed on the zone.",
"examples": [
"10000"
]
},
"last_checked_at": {
"type": [
"string",
"null"
],
"description": "The date and time of the last check performed on the zone.",
"examples": [
"2025-03-01T00:00:00+00:00"
]
},
"last_changed_at": {
"type": [
"string",
"null"
],
"description": "The date and time of the last change detected on the zone.",
"examples": [
"2025-03-01T00:00:00+00:00"
]
},
"next_scheduled_check_at": {
"type": [
"string",
"null"
],
"description": "The date and time of the next scheduled check for the zone.",
"examples": [
"2025-03-01T00:00:00+00:00"
]
},
"snoozed_until": {
"type": [
"string",
"null"
],
"description": "The date and time when the zone notifications are snoozed until.",
"examples": [
"2025-03-01T00:00:00+00:00",
null
]
},
"created_at": {
"type": "string",
"description": "The date and time when the zone was added to ZoneWatcher.",
"examples": [
"2025-03-01T00:00:00+00:00"
]
},
"updated_at": {
"type": "string",
"description": "The date and time when the zone was last updated.",
"examples": [
"2025-03-01T00:00:00+00:00"
]
},
"tags": {
"type": "array",
"description": "Tags on the zone. Provider tags are read-only and refresh from the DNS host. Custom tags are set in ZoneWatcher.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"origin": {
"type": "string"
},
"scope": {
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"origin",
"scope"
]
}
}
},
"required": [
"id",
"domain",
"domain_reversed",
"status",
"provider_id",
"failed_counter",
"failed_whois_counter",
"lifetime_checks",
"last_checked_at",
"last_changed_at",
"next_scheduled_check_at",
"snoozed_until",
"created_at",
"updated_at",
"tags"
],
"title": "ZoneResource"
}
},
"responses": {
"AuthenticationException": {
"description": "Unauthenticated",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"ValidationException": {
"description": "Validation error",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Errors overview."
},
"errors": {
"type": "object",
"description": "A detailed description of each field that failed validation.",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"AuthorizationException": {
"description": "Authorization error",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"ModelNotFoundException": {
"description": "Not found",
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
}
}
}
}