{ "opencollection": "1.0.0", "info": { "name": "Hetzner Cloud Actions Primary IPs API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Primary IPs", "type": "folder" }, "items": [ { "info": { "name": "List Primary IPs", "type": "http" }, "http": { "method": "GET", "url": "https://api.hetzner.cloud/v1/primary_ips", "params": [ { "name": "name", "value": "", "type": "query", "description": "Filter resources by their name.\n\nThe response will only contain the resources\nmatching exactly the specified name.\n" }, { "name": "label_selector", "value": "", "type": "query", "description": "Filter resources by labels.\n\nThe response will only contain resources matching the label selector.\nFor more information, see \"[Label Selector](#description/label-selector)\".\n" }, { "name": "ip", "value": "127.0.0.1", "type": "query", "description": "Filter results by IP address." }, { "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)\"." }, { "name": "sort", "value": "", "type": "query", "description": "Sort resources by field and direction. May be used multiple times.\n\nFor more information, see \"[Sorting](#description/sorting)\".\n" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List multiple [Primary IPs](#tag/primary-ips).\n\nUse the provided URI parameters to modify the result.\n" }, { "info": { "name": "Create a Primary IP", "type": "http" }, "http": { "method": "POST", "url": "https://api.hetzner.cloud/v1/primary_ips", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new [Primary IP](#tag/primary-ips).\n\nCan optionally be assigned to a resource by providing an `assignee_id` and `assignee_type`.\n\nIf not assigned to a resource the `location` key needs to be provided. This can be either the ID or the name of the [Location](#tag/locations) this [Primary IP](#tag/primary-ips) shall be created in.\n\nA [Primary IP](#tag/primary-ips) can only be assigned to resource in the same [Location](#tag/locations) later on.\n\nThe `datacenter` key is deprecated in favor " }, { "info": { "name": "Get a Primary IP", "type": "http" }, "http": { "method": "GET", "url": "https://api.hetzner.cloud/v1/primary_ips/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Primary IP." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a [Primary IP](#tag/primary-ips).\n" }, { "info": { "name": "Update a Primary IP", "type": "http" }, "http": { "method": "PUT", "url": "https://api.hetzner.cloud/v1/primary_ips/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Primary IP." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a [Primary IP](#tag/primary-ips).\n\nIf another change is concurrently performed on this [Primary IP](#tag/primary-ips), a error response with code `conflict` will be returned.\n" }, { "info": { "name": "Delete a Primary IP", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.hetzner.cloud/v1/primary_ips/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Primary IP." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deletes a [Primary IP](#tag/primary-ips).\n\nThe [Server](#tag/servers) must be powered off (status `off`) in order for this operation to succeed.\nIf assigned to a [Server](#tag/servers) the [Primary IP](#tag/primary-ips) will be unassigned automatically until 1 May 2026. After this date, the [Primary IP](#tag/primary-ips) needs to be unassigned before it can be deleted.\n\n#### Operation specific errors\n\n| Status | Code | Description |\n| --- | --- | --- |\n| `422` | `must_be_unassigned` | Error when" } ] } ], "bundled": true }