PATCH /v1/domains/records/{recordId}
Updates an existing DNS record for a domain name.
Servers
- https://api.vercel.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
recordId |
String | Yes |
The id of the DNS record |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
teamId |
String | No |
The Team identifier to perform the request on behalf of. |
slug |
String | No |
The Team slug to perform the request on behalf of. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
ttl |
Integer | No |
The Time to live (TTL) value of the DNS record |
https |
Object | No | |
https.priority |
Integer | Yes | |
https.params |
String | No | |
https.target |
String | Yes | |
comment |
String | No |
A comment to add context on what this DNS record is for |
name |
String | No |
The name of the DNS record |
mxPriority |
Integer | No |
The MX priority value of the DNS record |
type |
String | No |
The type of the DNS record Possible values:
|
value |
String | No |
The value of the DNS record |
srv |
Object | No | |
srv.priority |
Integer | Yes | |
srv.port |
Integer | Yes | |
srv.target |
String | Yes | |
srv.weight |
Integer | Yes |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.