{ "opencollection": "1.0.0", "info": { "name": "Hetzner Cloud Actions Zone Actions API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Zone Actions", "type": "folder" }, "items": [ { "info": { "name": "List Actions", "type": "http" }, "http": { "method": "GET", "url": "https://api.hetzner.cloud/v1/zones/actions", "params": [ { "name": "id", "value": "", "type": "query", "description": "Filter the actions by ID. May be used multiple times.\n\nThe response will only contain actions matching the specified IDs.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort actions by field and direction. May be used multiple times.\n\nFor more information, see \"[Sorting](#description/sorting)\".\n" }, { "name": "status", "value": "", "type": "query", "description": "Filter the actions by status. May be used multiple times.\n\nThe response will only contain actions matching the specified statuses.\n" }, { "name": "page", "value": "", "type": "query", "description": "Page number to return. For more information, see \"[Pagination](#description/pagination)\"." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of entries returned per page. For more information, see \"[Pagination](#description/pagination)\"." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns all [Zone](#tag/zones) [Actions](#tag/actions).\n\nUse the provided URI parameters to modify the result.\n" }, { "info": { "name": "Get an Action", "type": "http" }, "http": { "method": "GET", "url": "https://api.hetzner.cloud/v1/zones/actions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Action." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a specific [Action](#tag/actions).\n" }, { "info": { "name": "List Actions for a Zone", "type": "http" }, "http": { "method": "GET", "url": "https://api.hetzner.cloud/v1/zones/:id_or_name/actions", "params": [ { "name": "id_or_name", "value": "", "type": "path", "description": "ID or Name of the Zone." }, { "name": "sort", "value": "", "type": "query", "description": "Sort actions by field and direction. May be used multiple times.\n\nFor more information, see \"[Sorting](#description/sorting)\".\n" }, { "name": "status", "value": "", "type": "query", "description": "Filter the actions by status. May be used multiple times.\n\nThe response will only contain actions matching the specified statuses.\n" }, { "name": "page", "value": "", "type": "query", "description": "Page number to return. For more information, see \"[Pagination](#description/pagination)\"." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of entries returned per page. For more information, see \"[Pagination](#description/pagination)\"." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns all [Actions](#tag/actions) for a [Zone](#tag/zones).\n\nUse the provided URI parameters to modify the result.\n" }, { "info": { "name": "Get an Action for a Zone", "type": "http" }, "http": { "method": "GET", "url": "https://api.hetzner.cloud/v1/zones/:id_or_name/actions/:action_id", "params": [ { "name": "id_or_name", "value": "", "type": "path", "description": "ID or Name of the Zone." }, { "name": "action_id", "value": "", "type": "path", "description": "ID of the Action." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "**Deprecated**: This operation is deprecated, see our [changelog](https://docs.hetzner.cloud/changelog#2026-04-30-deprecate-get-resource-action-endpoints) for more details.\n\nReturns a specific [Action](#tag/actions) for a [Zone](#tag/zones).\n" }, { "info": { "name": "Change a Zone's Primary Nameservers", "type": "http" }, "http": { "method": "POST", "url": "https://api.hetzner.cloud/v1/zones/:id_or_name/actions/change_primary_nameservers", "params": [ { "name": "id_or_name", "value": "", "type": "path", "description": "ID or Name of the Zone." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Overwrites the primary nameservers of a [Zone](#tag/zones).\n\nOnly applicable for [Zones](#tag/zones) in secondary mode.\n\n#### Operation specific errors\n\n| Status | Code | Description |\n| --- | --- | --- |\n| `422` | `incorrect_zone_mode` | This operation is not supported for this Zone's `mode`. |\n" }, { "info": { "name": "Change a Zone's Protection", "type": "http" }, "http": { "method": "POST", "url": "https://api.hetzner.cloud/v1/zones/:id_or_name/actions/change_protection", "params": [ { "name": "id_or_name", "value": "", "type": "path", "description": "ID or Name of the Zone." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Changes the protection configuration of a [Zone](#tag/zones).\n" }, { "info": { "name": "Change a Zone's Default TTL", "type": "http" }, "http": { "method": "POST", "url": "https://api.hetzner.cloud/v1/zones/:id_or_name/actions/change_ttl", "params": [ { "name": "id_or_name", "value": "", "type": "path", "description": "ID or Name of the Zone." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Changes the default Time To Live (TTL) of a [Zone](#tag/zones).\n\nThis TTL is used for [RRSets](#tag/zone-rrsets) that do not explicitly define a TTL.\n\nOnly applicable for [Zones](#tag/zones) in primary mode.\n\n#### Operation specific errors\n\n| Status | Code | Description |\n| --- | --- | --- |\n| `422` | `incorrect_zone_mode` | This operation is not supported for this Zone's `mode`. |\n" }, { "info": { "name": "Import a Zone file", "type": "http" }, "http": { "method": "POST", "url": "https://api.hetzner.cloud/v1/zones/:id_or_name/actions/import_zonefile", "params": [ { "name": "id_or_name", "value": "", "type": "path", "description": "ID or Name of the Zone." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Imports a zone file, replacing all resource record sets ([RRSets](#tag/zone-rrsets)).\n\nThe import will fail if existing [RRSet](#tag/zone-rrsets) are `change` protected.\n\nSee [Zone file import](#tag/zones/zone-file-import) for more details.\nOnly applicable for [Zones](#tag/zones) in primary mode.\n\n#### Operation specific errors\n\n| Status | Code | Description |\n| --- | --- | --- |\n| `422` | `incorrect_zone_mode` | This operation is not supported for this Zone's `mode`. |\n" } ] } ], "bundled": true }