Vanity names are called vanity sets inside the API.
vst_sample123456
. (Read-only)vanity_set
. (Read-only)ns1
, ns0
, a
, a.ns
.external_ref
.nameserver_set_id
.id
(default).GET /v1/vanity sets
On success, 200 with 0 or more vanity sets.
{
"collection": [
{
"default_set": false,
"external_ref": null,
"id": "vst_sample123456",
"name": "ns1.example.com",
"nameserver_set_id": "nst_sample123456",
"object": "vanity_set",
"pattern": "ns1",
"vanity_domain": "example.com",
"vanity_zone_id": "zon_sample123456"
}
],
"more_results": false
}
GET /v1/vanity sets/vst_sample123456
On success, 200 with the vanity set.
{
"default_set": false,
"external_ref": null,
"id": "vst_sample123456",
"in_use": false,
"name": "ns1.example.com",
"nameserver_set_id": "nst_sample123456",
"object": "vanity_set",
"pattern": "ns1",
"vanity_domain": "example.com",
"vanity_zone_id": "zon_sample123456"
}
POST /v1/vanity sets
{
"vanity_set": {
"nameserver_set_id": "nst_sample123456",
"vanity_zone_id": "zon_sample123456"
}
}
On success, 201 with the new vanity set.
On error, 422 with standard error response.
{
"default_set": false,
"external_ref": null,
"id": "vst_sample123456",
"in_use": false,
"name": "ns1.example.com",
"nameserver_set_id": "nst_sample123456",
"object": "vanity_set",
"pattern": "ns1",
"vanity_domain": "example.com",
"vanity_zone_id": "zon_sample123456"
}
PUT /v1/vanity sets/vst_sample123456
{
"vanity_set": {
"pattern": "ns1"
}
}
On success, 200 with the updated vanity set.
On error, 422 with standard error response.
{
"default_set": false,
"external_ref": null,
"id": "vst_sample123456",
"in_use": false,
"name": "ns1.example.com",
"nameserver_set_id": "nst_sample123456",
"object": "vanity_set",
"pattern": "ns1",
"vanity_domain": "example.com",
"vanity_zone_id": "zon_sample123456"
}
DELETE /v1/vanity sets/vst_sample123456
On success, 202 with an empty response.
On error, 422 with standard error response.