---
updatedAt: 2026-07-29T09:06:46.000Z
---

# ANS availability

Check ANS name availability (returns 204 if available, 409 if taken)

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "CantonView Public API",
    "description": "Public API for accessing Canton Network explorer data through CCView",
    "contact": {
      "name": "API Maintainer",
      "email": "cantonview@pixelplex.io"
    },
    "license": {
      "name": ""
    },
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://ccview.io",
      "description": "Production HTTPS server"
    }
  ],
  "paths": {
    "/api/ans/availability/{name}": {
      "get": {
        "tags": [
          "Governance, ANS & Search"
        ],
        "summary": "ANS availability",
        "description": "Check ANS name availability (returns 204 if available, 409 if taken)",
        "operationId": "ans_availability_v1",
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "hostname",
              "maxLength": 255,
              "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])?)*$"
            },
            "example": "user.cns"
          }
        ],
        "responses": {
          "204": {
            "description": "ANS name is available"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "status",
                    "message",
                    "timestamp"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Detailed message description.",
                      "example": "message error"
                    },
                    "status": {
                      "type": "integer",
                      "format": "int32",
                      "description": "HTTP status code.",
                      "maximum": 599,
                      "minimum": 400
                    },
                    "timestamp": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Timestamp of error occurrence."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "status",
                    "message",
                    "timestamp"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Detailed message description.",
                      "example": "message error"
                    },
                    "status": {
                      "type": "integer",
                      "format": "int32",
                      "description": "HTTP status code.",
                      "maximum": 599,
                      "minimum": 400
                    },
                    "timestamp": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Timestamp of error occurrence."
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "status",
                    "message",
                    "timestamp"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Detailed message description.",
                      "example": "message error"
                    },
                    "status": {
                      "type": "integer",
                      "format": "int32",
                      "description": "HTTP status code.",
                      "maximum": 599,
                      "minimum": 400
                    },
                    "timestamp": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Timestamp of error occurrence."
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "ANS name is already taken"
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "status",
                    "message",
                    "timestamp"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Detailed message description.",
                      "example": "message error"
                    },
                    "status": {
                      "type": "integer",
                      "format": "int32",
                      "description": "HTTP status code.",
                      "maximum": 599,
                      "minimum": 400
                    },
                    "timestamp": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Timestamp of error occurrence."
                    }
                  }
                }
              }
            }
          },
          "501": {
            "description": "Not Implemented",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "status",
                    "message",
                    "timestamp"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Detailed message description.",
                      "example": "message error"
                    },
                    "status": {
                      "type": "integer",
                      "format": "int32",
                      "description": "HTTP status code.",
                      "maximum": 599,
                      "minimum": 400
                    },
                    "timestamp": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Timestamp of error occurrence."
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key"
      }
    }
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "tags": [
    {
      "name": "Governance, ANS & Search",
      "description": "Amulet Name Service (ANS) data"
    }
  ],
  "externalDocs": {
    "url": "https://swagger.io/resources/open-api/",
    "description": "OpenAPI Documentation Reference"
  }
}
```