Internet Service¶
List Internet Service¶
List all visible internet_services.
Synchronous / Asynchronous¶
Synchronous
Request¶
HTTP Request Method¶
GET
HTTP Request Path¶
{endpoint}/v2.0/internet_services
HTTP Request Parameters¶
Parameter |
Style |
Type |
Format |
Enumeration |
Description |
Required |
---|---|---|---|---|---|---|
description |
query |
string |
- |
- |
Description of the Internet Service |
no |
id |
query |
string |
hyph-uuid |
- |
Unique ID of the Internet Service |
no |
minimal_submask_length |
query |
integer |
- |
- |
Don't allow allocating public IP blocks with shorter mask (i.e. larger subnets) |
no |
name |
query |
string |
- |
- |
Name of the Internet Service |
no |
zone |
query |
string |
- |
- |
Name of zone |
no |
Response¶
HTTP Response Code List¶
Response Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
UnAuthorized |
404 |
Not Found |
500 |
Internal Server Error |
HTTP Response Parameters¶
Parameter |
Type |
Format |
Description |
---|---|---|---|
internet_services |
array<object> |
datatype_internet_service |
- |
description |
string |
- |
Description of the Internet Service |
id |
string |
hyph-uuid |
Unique ID of the Internet Service |
minimal_submask_length |
integer |
- |
Don't allow allocating public IP blocks with shorter mask (i.e. larger subnets) |
name |
string |
- |
Name of the Internet Service |
zone |
string |
- |
Name of zone |
Examples¶
Sample Request Body¶
This operation does not send a request body.
Sample Response Body¶
{
"internet_services": [
{
"description": "lab3 internet connectivity provider",
"id": "a7791c79-19b0-4eb6-9a8f-ea739b44e8d5",
"minimal_submask_length": 26,
"name": "Lab3-Internet-Service-Provider-01",
"zone": "Lab3"
},
{
"description": "Example internet_service 2 description.",
"id": "5d6eaf32-8c42-4187-973b-dcee142dcb9d",
"minimal_submask_length": 26,
"name": "Example internet_service 2",
"zone": "Lab3"
}
]
}
Show Internet Service¶
Show details for internet_service.
Synchronous / Asynchronous¶
Synchronous
Request¶
HTTP Request Method¶
GET
HTTP Request Path¶
{endpoint}/v2.0/internet_services/{internet_service_id}
HTTP Request Parameters¶
Parameter |
Style |
Type |
Format |
Enumeration |
Description |
Required |
---|---|---|---|---|---|---|
internet_service_id |
URI |
string |
hyph-uuid |
- |
Unique ID of the Internet Service |
yes |
Response¶
HTTP Response Code List¶
Response Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
UnAuthorized |
404 |
Not Found |
500 |
Internal Server Error |
HTTP Response Parameters¶
Parameter |
Type |
Format |
Description |
---|---|---|---|
internet_service |
object |
datatype_internet_service |
- |
description |
string |
- |
Description of the Internet Service |
id |
string |
hyph-uuid |
Unique ID of the Internet Service |
minimal_submask_length |
integer |
- |
Don't allow allocating public IP blocks with shorter mask (i.e. larger subnets) |
name |
string |
- |
Name of the Internet Service |
zone |
string |
- |
Name of zone |
Examples¶
Sample Request Body¶
This operation does not send a request body.
Sample Response Body¶
{
"internet_service": {
"description": "lab3 internet connectivity provider",
"id": "a7791c79-19b0-4eb6-9a8f-ea739b44e8d5",
"minimal_submask_length": 26,
"name": "Lab3-Internet-Service-Provider-01",
"zone": "Lab3"
}
}