Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Cloud API allows contract administrators, owners, and authenticated users with the required permissions to create a NSG and associate it with Network Interface Cards (NICs) or Virtual Machine (VM) resources.
Learn how to create a Default NSG.
Learn how to create a Custom NSG.
Learn how to convert a Custom NSG to a Default NSG.
Learn how to retrieve a NSG by Group ID.
Learn how to retrieve your NSGs.
Learn how to update a NSG.
Learn how to delete your NSGs.
Learn how to create a Firewall rule for the specified NSG.
Learn how to retrieve all Firewall rules for the specified NSG.
Learn how to update Firewall rule of the specified NSG.
Learn how to delete a firewall rule from a NSG.
Learn how to attach a list of NSGs to a server or NIC.
Note: Only contract administrators, owners, and users with both permissions to the VDC concerned and createNetworkSecurityGroups
privilege can create NSGs via API.
Prerequisite: You need an IONOS Cloud account with API credentials configured with the appropriate permissions.
You can create a Default NSG with predefined rules at the time of creation or during the update of a datacenter. You can use any of the following Cloud API requests with the property createDefaultSecurityGroup
set to true
and the other required properties:
POST /datacenters/
PUT /datacenters/{datacenterId}
PATCH /datacenters/{datacenterId}
202 Accepted
Note: For CloudAPI, some resources are created asynchronously. You can check for the progress via the Status URL that is returned in the response header of the POST or PUT call.
Note: Only contract administrators, owners, and users with permissions to the VDC concerned can create and manage NSGs via API.
Prerequisite: You need an IONOS Cloud account with API credentials configured with the appropriate permissions.
To update a NSG, you need to use the following PUT
or PATCH
request providing the datacenterId
, securityGroupId
and the required properties:
PUT(PATCH) /datacenters/{datacenterId}/securitygroups/{securityGroupId}
202 Accepted
Note: For CloudAPI, some resources are created asynchronously. You can check for the progress via the Status URL that is returned in the response header of the POST or PUT call.
Note: Only contract administrators, owners, and users with both permissions to the VDC concerned and createNetworkSecurityGroups
privilege can create NSGs via API.
Prerequisite: You need an IONOS Cloud account with API credentials configured with the appropriate permissions.
To create a Custom NSG, you need to use the following POST
request providing the datacenterId
and the required properties:
POST /datacenters/{datacenterId}/securitygroups
202 Accepted
Note: For CloudAPI, some resources are created asynchronously. You can check for the progress via the Status URL that is returned in the response header of the POST or PUT call.
Note: Only contract administrators, owners, and users with permissions to the VDC concerned can create and manage NSGs via API.
Prerequisite: You need an IONOS Cloud account with API credentials configured with the appropriate permissions.
To create a firewall rule for a NSG, you need to use the following POST
request providing the datacenterId
and securityGroupId
:
POST /datacenters/{datacenterId}/securitygroups/{securityGroupId}/rules
202 Accepted
Note: For CloudAPI, some resources are created asynchronously. You can check for the progress via the Status URL that is returned in the response header of the POST or PUT call.
Note: Only contract administrators, owners, and users with permissions to the VDC concerned can create and manage NSGs via API.
Prerequisite: You need an IONOS Cloud account with API credentials configured with the appropriate permissions.
You can convert a Custom NSG to a Default NSG during the update of a datacenter. You can use any of the following requests with the property defaultSecurityGroupId
set to UUID of the NSG to be converted and the other required properties:
PUT /datacenters/{datacenterId}
PATCH /datacenters/{datacenterId}
202 Accepted
Note: For CloudAPI, some resources are created asynchronously. You can check for the progress via the Status URL that is returned in the response header of the POST or PUT call.
Note: Only contract administrators, owners, and users with permissions to the VDC concerned can create and manage NSGs via API.
Prerequisite: You need an IONOS Cloud account with API credentials configured with the appropriate permissions.
To delete a NSG, you need to use the following DELETE
request providing the datacenterId
and securityGroupId
:
DELETE /datacenters/{datacenterId}/securitygroups/{securityGroupId}
202 Accepted
Note: Only contract administrators, owners, and users with permissions to the VDC concerned can create and manage NSGs via API.
Prerequisite: You need an IONOS Cloud account with API credentials configured with the appropriate permissions.
To retrieve the NSGs, you need to use the following GET
request using the datacenter ID
:
GET /datacenters/{datacenterId}/securitygroups
200 OK
Note: Only contract administrators, owners, and users with permissions to the VDC concerned can create and manage NSGs via API.
Prerequisite: You need an IONOS Cloud account with API credentials configured with the appropriate permissions.
To retrieve the NSGs, you need to use the following GET
request using the datacenter ID
and securityGroupId
:
GET /datacenters/{datacenterId}/securitygroups/{securityGroupId}
200 OK
Note: Updating the list of Security Groups attached to an existing server specified by its ID. Security Groups should already exist as part of the datacenter.
Note: Only contract administrators, owners, and users with permissions to the VDC concerned can create and manage NSGs via API.
Prerequisite: You need an IONOS Cloud account with API credentials configured with the appropriate permissions.
To attach a list of NSGs to a server, you need to use the following Cloud API PUT
request providing the datacenterId
,serverId
and the IDs of the security groups in the body:
PUT /datacenters/{datacenterId}/servers/{serverId}/securitygroups
Similarly for a NIC, provide the datacenterId
, nicId
and the IDs of the security groups in the body:
PUT /datacenters/{datacenterId}/servers/{serverId}/nic/{nicId}/securitygroups
200 Accepted
Note: Only contract administrators, owners, and users with permissions to the VDC concerned can create and manage NSGs via API.
Prerequisite: You need an IONOS Cloud account with API credentials configured with the appropriate permissions.
To retrieve the firewall rules by Network Security Group ID, you need to use one of the following Cloud APIGET
request using the datacenterId
and securityGroupId
:
GET /datacenters/{datacenterId}/securitygroups/{securityGroupId}/rules
GET /datacenters/{datacenterId}/securitygroups/{securityGroupId}/rules/{ruleId}
200 OK
Note: Only contract administrators, owners, and users with permissions to the VDC concerned can create and manage NSGs via API.
Prerequisite: You need an IONOS Cloud account with API credentials configured with the appropriate permissions.
To delete a firewall rule from a NSG, you need to use the following Cloud API DELETE
request providing the datacenterId
, securityGroupId
and ruleId
:
DELETE /datacenters/{datacenterId}/securitygroups/{securityGroupId}/rules/{ruleId}
202 Accepted