Skip to content

Sync to latest upstream changes #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MaximilianKoestler merged 3 commits into from
Nov 22, 2025
Merged

Sync to latest upstream changes #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
93eeac2
Doc: Update descriptions from upstream
HenningHolmDE Nov 22, 2025
ebf0601
Schema: Add API to update RRs' comments of a RRSet
HenningHolmDE Nov 22, 2025
bd679b1
Schema!: Change metrics query types to arrays
HenningHolmDE Nov 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,8 @@ This API description is currently being used by the following projects:
/zones/{id_or_name}/rrsets/{rr_name}/{rr_type}/actions/change_ttl (POST)
/zones/{id_or_name}/rrsets/{rr_name}/{rr_type}/actions/remove_records (POST)
/zones/{id_or_name}/rrsets/{rr_name}/{rr_type}/actions/set_records (POST)
/zones/{id_or_name}/rrsets/{rr_name}/{rr_type}/actions/update_records (POST)
/zones/{id_or_name}/zonefile (GET)

# Storage Boxes

Expand Down
173 changes: 157 additions & 16 deletions openapi/hcloud.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
},
"description": "Copied from the official API documentation for the Public Hetzner Cloud.",
"title": "Hetzner Cloud API",
"version": "2231c30"
"version": "ebf0601"
},
"servers": [
{
Expand Down Expand Up @@ -6928,7 +6928,7 @@
"type": "object"
},
"records": {
"description": "Records of the RRSet.\n\nMust not be empty and must only contain distinct record values.\n",
"description": "Records of the RRSet.\n\nMust not be empty and must only contain distinct record values.\nThe order of records returned in responses is not guaranteed to be consistent.\n",
"items": {
"$ref": "#/components/schemas/resource_record"
},
Expand Down Expand Up @@ -6978,7 +6978,7 @@
"type": "string"
},
"records": {
"description": "Records of the RRSet.\n\nMust not be empty and must only contain distinct record values.\n",
"description": "Records of the RRSet.\n\nMust not be empty and must only contain distinct record values.\nThe order of records returned in responses is not guaranteed to be consistent.\n",
"items": {
"$ref": "#/components/schemas/resource_record"
},
Expand Down Expand Up @@ -8478,6 +8478,37 @@
"title": "UpdateLoadBalancerService",
"type": "object"
},
"update_records_of_rrset_request": {
"description": "Request for POST https://api.hetzner.cloud/v1/zones/{id_or_name}/rrsets/{rr_name}/{rr_type}/actions/update_records",
"properties": {
"records": {
"description": "Records to update in the RRSet.\n\nMust not be empty and must only contain distinct record values.\n",
"items": {
"$ref": "#/components/schemas/resource_record"
},
"maxItems": 50,
"minItems": 1,
"type": "array"
}
},
"required": [
"records"
],
"type": "object"
},
"update_records_of_rrset_response": {
"description": "Response to POST https://api.hetzner.cloud/v1/zones/{id_or_name}/rrsets/{rr_name}/{rr_type}/actions/update_records",
"properties": {
"action": {
"$ref": "#/components/schemas/action"
}
},
"required": [
"action"
],
"title": "ActionResponse",
"type": "object"
},
"update_service_request": {
"$ref": "#/components/schemas/update_load_balancer_service"
},
Expand Down Expand Up @@ -15484,13 +15515,16 @@
"name": "type",
"required": true,
"schema": {
"enum": [
"open_connections",
"connections_per_second",
"requests_per_second",
"bandwidth"
],
"type": "string"
"items": {
"enum": [
"open_connections",
"connections_per_second",
"requests_per_second",
"bandwidth"
],
"type": "string"
},
"type": "array"
}
},
{
Expand Down Expand Up @@ -21520,12 +21554,15 @@
"name": "type",
"required": true,
"schema": {
"enum": [
"cpu",
"disk",
"network"
],
"type": "string"
"items": {
"enum": [
"cpu",
"disk",
"network"
],
"type": "string"
},
"type": "array"
}
},
{
Expand Down Expand Up @@ -28154,6 +28191,110 @@
}
]
},
"/zones/{id_or_name}/rrsets/{rr_name}/{rr_type}/actions/update_records": {
"post": {
"description": "Updates resource records' (RRs) comments of an existing RRSet in the Zone.\n\nOnly applicable for Zones in primary mode.\n\n#### Call specific error codes\n\n| Code | Description |\n|-----------------------|----------------------------------|\n| `incorrect_zone_mode` | The zone is not in primary mode. |\n",
"operationId": "update_records_of_rrset",
"parameters": [
{
"description": "ID or Name of the Zone.",
"in": "path",
"name": "id_or_name",
"required": true,
"schema": {
"description": "ID or Name of the Zone.",
"type": "string"
}
},
{
"in": "path",
"name": "rr_name",
"required": true,
"schema": {
"description": "Name of the RRSet.\n\nThe name must be in lower case, and must not end with a dot or the Zone\nname. Names containing non-ASCII characters must be transcribed to\n[Punycode](https://wikipedia.org/wiki/Punycode) representation with ACE prefix, e.g.\n`xn--4bi` (✉️).\n\nFor the Zone apex, use `@`.\n",
"example": "www",
"type": "string"
}
},
{
"in": "path",
"name": "rr_type",
"required": true,
"schema": {
"description": "Type of the RRSet.\n",
"enum": [
"A",
"AAAA",
"CAA",
"CNAME",
"DS",
"HINFO",
"HTTPS",
"MX",
"NS",
"PTR",
"RP",
"SOA",
"SRV",
"SVCB",
"TLSA",
"TXT"
],
"example": "A",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/update_records_of_rrset_request"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"action": {
"command": "update_rrset_records",
"error": null,
"finished": null,
"id": 1,
"progress": 50,
"resources": [
{
"id": 42,
"type": "zone"
}
],
"started": "2016-01-30T23:55:00+00:00",
"status": "running"
}
},
"schema": {
"$ref": "#/components/schemas/update_records_of_rrset_response"
}
}
},
"description": "Request succeeded."
}
},
"summary": "Update Records of an RRSet",
"tags": [
"zones"
]
},
"servers": [
{
"url": "https://api.hetzner.cloud/v1"
}
]
},
"/zones/{id_or_name}/zonefile": {
"get": {
"description": "Returns a generated Zone file in BIND (RFC [1034](https://datatracker.ietf.org/doc/html/rfc1034)/[1035](https://datatracker.ietf.org/doc/html/rfc1035)) format.\n\nOnly applicable for Zones in primary mode.\n\n#### Call specific error codes\n\n| Code | Description |\n|-----------------------|----------------------------------|\n| `incorrect_zone_mode` | The zone is not in primary mode. |\n",
Expand Down
1 change: 1 addition & 0 deletions resources/paths.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,5 +169,6 @@
"/zones/{id_or_name}/rrsets/{rr_name}/{rr_type}/actions/change_ttl",
"/zones/{id_or_name}/rrsets/{rr_name}/{rr_type}/actions/remove_records",
"/zones/{id_or_name}/rrsets/{rr_name}/{rr_type}/actions/set_records",
"/zones/{id_or_name}/rrsets/{rr_name}/{rr_type}/actions/update_records",
"/zones/{id_or_name}/zonefile"
]
Loading