{
  "openapi": "3.1.1",
  "info": {
    "title": "DnsMe | v1",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.dns-me.com/"
    }
  ],
  "paths": {
    "/v2/status": {
      "get": {
        "tags": [
          "Ops"
        ],
        "summary": "Public service statistics: IP updates and DNS queries (last hour / 24 h, hourly). Numbers only.",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/Update": {
      "get": {
        "tags": [
          "Legacy"
        ],
        "summary": "Updates the IP of a device with the caller's IP (legacy API).",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "password",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "post": {
        "tags": [
          "Legacy"
        ],
        "summary": "Updates IPv4/IPv6 of a device (legacy API, JSON or form body).",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/nic/update": {
      "get": {
        "tags": [
          "DynDNS"
        ],
        "summary": "dyndns2 compatible update (Basic auth: device name / secret).",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v2/admin/stats": {
      "get": {
        "tags": [
          "Admin"
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/healthz": {
      "get": {
        "tags": [
          "Ops"
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v2/myip": {
      "get": {
        "tags": [
          "Devices"
        ],
        "summary": "Returns the public IP address of the caller.",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v2/devices/{name}/update": {
      "post": {
        "tags": [
          "Devices"
        ],
        "summary": "Updates the addresses of a device. Without body the caller IP is used. Body: {\"ipv4\":\"auto\"|\"1.2.3.4\"|null, \"ipv6\":...}; omitted fields stay unchanged.",
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v2/devices/{name}": {
      "get": {
        "tags": [
          "Devices"
        ],
        "summary": "Current DNS state of a device (device auth).",
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v2/devices/{name}/acme": {
      "put": {
        "tags": [
          "Devices"
        ],
        "summary": "Publishes an ACME DNS-01 challenge TXT record (_acme-challenge.<device>).",
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "delete": {
        "tags": [
          "Devices"
        ],
        "summary": "Removes ACME challenge TXT record(s) (all if no value is given).",
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "value",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v2/account/register": {
      "post": {
        "tags": [
          "Account"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Credentials"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v2/account/login": {
      "post": {
        "tags": [
          "Account"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Credentials"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v2/account/logout": {
      "post": {
        "tags": [
          "Account"
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v2/account": {
      "get": {
        "tags": [
          "Account"
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v2/account/password": {
      "post": {
        "tags": [
          "Account"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PasswordChange"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v2/manage/devices": {
      "get": {
        "tags": [
          "Management"
        ],
        "parameters": [
          {
            "name": "search",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "skip",
            "in": "query",
            "schema": {
              "pattern": "^-?(?:0|[1-9]\\d*)$",
              "type": [
                "integer",
                "string"
              ],
              "format": "int32"
            }
          },
          {
            "name": "take",
            "in": "query",
            "schema": {
              "pattern": "^-?(?:0|[1-9]\\d*)$",
              "type": [
                "integer",
                "string"
              ],
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "post": {
        "tags": [
          "Management"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewDevice"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v2/manage/devices/{name}": {
      "delete": {
        "tags": [
          "Management"
        ],
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v2/manage/devices/{name}/rotate": {
      "post": {
        "tags": [
          "Management"
        ],
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v2/manage/groups": {
      "get": {
        "tags": [
          "Management"
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "post": {
        "tags": [
          "Management"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewGroup"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v2/manage/groups/{prefix}/rotate": {
      "post": {
        "tags": [
          "Management"
        ],
        "parameters": [
          {
            "name": "prefix",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v2/manage/groups/{prefix}": {
      "delete": {
        "tags": [
          "Management"
        ],
        "parameters": [
          {
            "name": "prefix",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Credentials": {
        "required": [
          "email",
          "password"
        ],
        "type": "object",
        "properties": {
          "email": {
            "type": [
              "null",
              "string"
            ]
          },
          "password": {
            "type": [
              "null",
              "string"
            ]
          }
        }
      },
      "NewDevice": {
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "name": {
            "type": [
              "null",
              "string"
            ]
          }
        }
      },
      "NewGroup": {
        "required": [
          "prefix",
          "description"
        ],
        "type": "object",
        "properties": {
          "prefix": {
            "type": [
              "null",
              "string"
            ]
          },
          "description": {
            "type": [
              "null",
              "string"
            ]
          }
        }
      },
      "PasswordChange": {
        "required": [
          "current",
          "new"
        ],
        "type": "object",
        "properties": {
          "current": {
            "type": [
              "null",
              "string"
            ]
          },
          "new": {
            "type": [
              "null",
              "string"
            ]
          }
        }
      }
    }
  },
  "tags": [
    {
      "name": "Ops"
    },
    {
      "name": "Legacy"
    },
    {
      "name": "DynDNS"
    },
    {
      "name": "Admin"
    },
    {
      "name": "Devices"
    },
    {
      "name": "Account"
    },
    {
      "name": "Management"
    }
  ]
}