This endpoint is used for registering a new domain name with Vercel for the authenticating user, and also for initiating a domain transfer request from an external Registrar to Vercel.
643 matches
58 actions
Vercel
58 actions
- Create a DNS recordPOSTv1.0.0
- Create a new secretPOSTv1.0.0
- Create a TeamPOSTv1.0.0
- Create an Edge ConfigPOSTv1.0.0
- Create one or more environment variablesPOSTv1.0.0
- Creates a Configurable Log DrainPOSTv1.0.0
- Creates a new CheckPOSTv1.0.0
- Creates a new Integration Log DrainPOSTv1.0.0
- Delete a DeploymentDELETEv1.0.0
- Delete a ProjectDELETEv1.0.0
- Delete a secretDELETEv1.0.0
- Delete a TeamDELETEv1.0.0
- Delete an AliasDELETEv1.0.0
- Delete an Edge ConfigDELETEv1.0.0
- Delete an integration configurationDELETEv1.0.0
- Deletes a Configurable Log DrainDELETEv1.0.0
- Deletes the Integration log drain with the provided `id`DELETEv1.0.0
- Find a project by id or nameGETv1.0.0
- Get a deployment by ID or URLGETv1.0.0
- Get a Domain's configurationGETv1.0.0
- Get a project domainGETv1.0.0
- Get a single checkGETv1.0.0
- Get a single secretGETv1.0.0
- Get a TeamGETv1.0.0
- Get access request statusGETv1.0.0
- Get an AliasGETv1.0.0
- Get an Edge ConfigGETv1.0.0
- Get an Edge Config itemGETv1.0.0
- Get cert by idGETv1.0.0
- Get configurations for the authenticated user or teamGETv1.0.0
- Get Deployment File ContentsGETv1.0.0
- Get Edge Config itemsGETv1.0.0
- Get Edge ConfigsGETv1.0.0
- Get Information for a Single DomainGETv1.0.0
- Get status of Remote Caching for this principalGETv1.0.0
- Get the UserGETv1.0.0
- List aliasesGETv1.0.0
- List all teamsGETv1.0.0
- List all the domainsGETv1.0.0
- List Deployment AliasesGETv1.0.0
- List Deployment BuildsGETv1.0.0
- List Deployment FilesGETv1.0.0
- List existing DNS recordsGETv1.0.0
- List git namespaces by providerGETv1.0.0
- List git repositories linked to namespace by providerGETv1.0.0
- List secretsGETv1.0.0
- List team membersGETv1.0.0
- List User EventsGETv1.0.0
- Query information about an artifactPOSTv1.0.0
- Register or transfer-in a new DomainPOSTv1.0.0
- Remove a domain by nameDELETEv1.0.0
- Retrieve a list of all checksGETv1.0.0
- Retrieve an integration configurationGETv1.0.0
- Retrieve the decrypted value of an environment variable of a project by idGETv1.0.0
- Retrieve the environment variables of a project by id or nameGETv1.0.0
- Retrieves a Configurable Log DrainGETv1.0.0
- Retrieves a list of Configurable Log DrainsGETv1.0.0
- Retrieves a list of Integration log drainsGETv1.0.0
Infrastructure/Vercel
Register or transfer-in a new Domain
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
{
"type": "object",
"properties": {
"method": {
"type": "string",
"description": "The domain operation to perform. It can be either `add` or `transfer-in`."
},
"teamId": {
"type": "string"
}
},
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "object",
"required": [
"boughtAt",
"createdAt",
"creator",
"expiresAt",
"id",
"intendedNameservers",
"name",
"nameservers",
"serviceType",
"verified"
],
"properties": {
"boughtAt": {
"type": [
"number",
"null"
],
"description": "If it was purchased through Vercel, the timestamp in milliseconds when it was purchased."
},
"createdAt": {
"type": "number",
"description": "Timestamp in milliseconds when the domain was created in the registry."
},
"creator": {
"type": "object",
"description": "An object containing information of the domain creator, including the user's id, username, and email.",
"required": [
"email",
"id",
"username"
],
"properties": {
"customerId": {
"type": [
"string",
"null"
]
},
"email": {
"type": "string"
},
"id": {
"type": "string"
},
"isDomainReseller": {
"type": "boolean"
},
"username": {
"type": "string"
}
}
},
"customNameservers": {
"type": "array",
"description": "A list of custom nameservers for the domain to point to. Only applies to domains purchased with Vercel.",
"items": {
"type": "string"
}
},
"expiresAt": {
"type": [
"number",
"null"
],
"description": "Timestamp in milliseconds at which the domain is set to expire. `null` if not bought with Vercel."
},
"id": {
"type": "string",
"description": "The unique identifier of the domain."
},
"intendedNameservers": {
"type": "array",
"description": "A list of the intended nameservers for the domain to point to Vercel DNS.",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"description": "The domain name."
},
"nameservers": {
"type": "array",
"description": "A list of the current nameservers of the domain.",
"items": {
"type": "string"
}
},
"orderedAt": {
"type": "number",
"description": "Timestamp in milliseconds at which the domain was ordered."
},
"renew": {
"type": "boolean",
"description": "Indicates whether the domain is set to automatically renew."
},
"serviceType": {
"type": "string",
"description": "The type of service the domain is handled by. `external` if the DNS is externally handled, `zeit.world` if handled with Vercel, or `na` if the service is not available.",
"enum": [
"zeit.world",
"external",
"na"
]
},
"transferStartedAt": {
"type": "number",
"description": "If transferred into Vercel, timestamp in milliseconds when the domain transfer was initiated."
},
"transferredAt": {
"type": [
"number",
"null"
],
"description": "Timestamp in milliseconds at which the domain was successfully transferred into Vercel. `null` if the transfer is still processing or was never transferred in."
},
"verified": {
"type": "boolean",
"description": "If the domain has the ownership verified."
}
}
}
}
}