Tenant Connection

This page describes operations you can perform on tenant connections. List, create, get details for, update, and delete.

List Tenant Connection

List all visible tenant connections.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/tenant_connections

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
approval_request_id query string hyph-uuid - Approval Request ID no
description query string - - Description of the Tenant Connection no
id query string hyph-uuid - Unique ID of the Tenant Connection no
interface_type query string - [‘firewall_interface’] Interface Type of the Tenant Connection no
name query string - - Name of the Tenant Connection no
progress query string - [‘REQUESTING’, ‘REQUEST_FAILED’, ‘REQUESTED’, ‘EXECUTED’, ‘DELETING’, ‘DELETE_FAILED’] Progress of the Tenant Connection. ‘REQUESTED’ assures only having succeeded in registering approval request, which means this doesn’t deal with other sss status (‘cancelled’, ‘approved’, ‘denied’ ‘expired’, ‘approval_expired’). no
tenant_id query string non-hyph-uuid - Tenant ID of the owner (UUID) 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
tenant_connections array<object> Tenant Connection -
approval_request_id string hyph-uuid Approval Request ID
connected_interface object - Properties used for Connected Interface properties
id string hyph-uuid Resource id of the Interface which Connects the Tenant
ip_address string ipv4 IP Address
virtual_ip_address string ipv4 Virtual IP Address
virtual_ip_properties object - Properties used for virtual IP address
protocol string - Redundancy Protocol
vrid integer - VRRP group identifier
connected_network object - Properties used for Connected Network
id string hyph-uuid Network ID
subnet_cidr string cidr Subnet CIDR.
tenant_id string non-hyph-uuid Tenant ID of the Connected Network (UUID)
description string - Description of the Tenant Connection
id string hyph-uuid Unique ID of the Tenant Connection
interface_type string - Interface Type of the Tenant Connection
name string - Name of the Tenant Connection
progress string - Progress of the Tenant Connection. ‘REQUESTED’ assures only having succeeded in registering approval request, which means this doesn’t deal with other sss status (‘cancelled’, ‘approved’, ‘denied’ ‘expired’, ‘approval_expired’).
tenant_id string non-hyph-uuid Tenant ID of the owner (UUID)

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "tenant_connections": [
    {
      "approval_request_id": "1d5e9218-34e2-4ae2-872a-30726d46ac49",
      "connected_interface": {
        "id": "af64dfc4-3451-44e0-b2ce-f1972d89c6dc",
        "ip_address": "192.168.100.4",
        "virtual_ip_address": "192.168.100.3",
        "virtual_ip_properties": {
          "protocol": "vrrp",
          "vrid": 120
        }
      },
      "connected_network": {
        "id": "39dafb75-aa70-4079-9f69-eb6ffed00d7d",
        "subnet_cidr": "192.168.100.0/24",
        "tenant_id": "18a0e390d1534fd48f25f259add006c5"
      },
      "description": "",
      "id": "2b757ea7-f346-4297-a598-4d054bc0ae58",
      "interface_type": "firewall_interface",
      "name": "example A",
      "progress": "REQUESTED",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    },
    {
      "approval_request_id": null,
      "connected_interface": {
        "id": "3ce36144-5543-4198-ad3c-cd33c4a85683",
        "ip_address": "192.168.100.5",
        "virtual_ip_address": "192.168.100.3",
        "virtual_ip_properties": {
          "protocol": "vrrp",
          "vrid": 120
        }
      },
      "connected_network": {
        "id": "39dafb75-aa70-4079-9f69-eb6ffed00d7d",
        "subnet_cidr": "192.168.100.0/24",
        "tenant_id": "18a0e390d1534fd48f25f259add006c5"
      },
      "description": "",
      "id": "b874ee6f-0adf-4211-bf02-4372b28b3f54",
      "interface_type": "firewall_interface",
      "name": "example B",
      "progress": "REQUESTED",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    }
  ]
}

Create Tenant Connection

Create tenant connection.

Synchronous / Asynchronous

  • Asynchronous

Request

HTTP Request Method

  • POST

HTTP Request Path

{endpoint}/v2.0/tenant_connections

HTTP Request Parameters

Parameter Style Type Format Enumeration Default Description Required
tenant_connection plain object Tenant Connection - - - yes
connected_interface plain object - - - Properties used for Connected Interface properties yes
id plain string hyph-uuid - - Resource id of the Interface which Connects the Tenant yes
ip_address plain string ipv4 - - IP Address yes
virtual_ip_address plain string ipv4 - null Virtual IP Address no
virtual_ip_properties plain object - - null Properties used for virtual IP address no
protocol plain string - [‘vrrp’] - Redundancy Protocol yes
vrid plain integer - - - VRRP group identifier yes
connected_network plain object - - - Properties used for Connected Network yes
id plain string hyph-uuid - - Network ID yes
subnet_cidr plain string cidr - null Subnet CIDR. no
tenant_id plain string non-hyph-uuid - - Tenant ID of the Connected Network (UUID) yes
description plain string - - “” Description of the Tenant Connection no
interface_type plain string - [‘firewall_interface’] - Interface Type of the Tenant Connection yes
name plain string - - “” Name of the Tenant Connection no
tenant_id plain string non-hyph-uuid - See notes. Tenant ID of the owner (UUID) no

Note

tenant_id: The ID of default tenant to which user belongs.

Response

HTTP Response Code List

Response Code Description
200 OK
400 Bad Request
401 UnAuthorized
404 Not Found
409 Conflict
500 Internal Server Error

HTTP Response Parameters

Parameter Type Format Description
tenant_connection object Tenant Connection -
approval_request_id string hyph-uuid Approval Request ID
connected_interface object - Properties used for Connected Interface properties
id string hyph-uuid Resource id of the Interface which Connects the Tenant
ip_address string ipv4 IP Address
virtual_ip_address string ipv4 Virtual IP Address
virtual_ip_properties object - Properties used for virtual IP address
protocol string - Redundancy Protocol
vrid integer - VRRP group identifier
connected_network object - Properties used for Connected Network
id string hyph-uuid Network ID
subnet_cidr string cidr Subnet CIDR.
tenant_id string non-hyph-uuid Tenant ID of the Connected Network (UUID)
description string - Description of the Tenant Connection
id string hyph-uuid Unique ID of the Tenant Connection
interface_type string - Interface Type of the Tenant Connection
name string - Name of the Tenant Connection
progress string - Progress of the Tenant Connection. ‘REQUESTED’ assures only having succeeded in registering approval request, which means this doesn’t deal with other sss status (‘cancelled’, ‘approved’, ‘denied’ ‘expired’, ‘approval_expired’).
tenant_id string non-hyph-uuid Tenant ID of the owner (UUID)

Examples

Sample Request Body

{
  "tenant_connection": {
    "connected_interface": {
      "id": "af64dfc4-3451-44e0-b2ce-f1972d89c6dc",
      "ip_address": "192.168.100.4",
      "virtual_ip_address": "192.168.100.3",
      "virtual_ip_properties": {
        "protocol": "vrrp",
        "vrid": 120
      }
    },
    "connected_network": {
      "id": "39dafb75-aa70-4079-9f69-eb6ffed00d7d",
      "subnet_cidr": "192.168.100.0/24",
      "tenant_id": "18a0e390d1534fd48f25f259add006c5"
    },
    "description": "",
    "interface_type": "firewall_interface",
    "name": "example A",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Sample Response Body

{
  "tenant_connection": {
    "approval_request_id": "1d5e9218-34e2-4ae2-872a-30726d46ac49",
    "connected_interface": {
      "id": "af64dfc4-3451-44e0-b2ce-f1972d89c6dc",
      "ip_address": "192.168.100.4",
      "virtual_ip_address": "192.168.100.3",
      "virtual_ip_properties": {
        "protocol": "vrrp",
        "vrid": 120
      }
    },
    "connected_network": {
      "id": "39dafb75-aa70-4079-9f69-eb6ffed00d7d",
      "subnet_cidr": "192.168.100.0/24",
      "tenant_id": "18a0e390d1534fd48f25f259add006c5"
    },
    "description": "",
    "id": "2b757ea7-f346-4297-a598-4d054bc0ae58",
    "interface_type": "firewall_interface",
    "name": "example A",
    "progress": "REQUESTING",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Show Tenant Connection

Show details for tenant connection.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/tenant_connections/{tenant_connection_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
tenant_connection_id URI string hyph-uuid - Unique ID of the Tenant Connection 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
tenant_connection object Tenant Connection -
approval_request_id string hyph-uuid Approval Request ID
connected_interface object - Properties used for Connected Interface properties
id string hyph-uuid Resource id of the Interface which Connects the Tenant
ip_address string ipv4 IP Address
virtual_ip_address string ipv4 Virtual IP Address
virtual_ip_properties object - Properties used for virtual IP address
protocol string - Redundancy Protocol
vrid integer - VRRP group identifier
connected_network object - Properties used for Connected Network
id string hyph-uuid Network ID
subnet_cidr string cidr Subnet CIDR.
tenant_id string non-hyph-uuid Tenant ID of the Connected Network (UUID)
description string - Description of the Tenant Connection
id string hyph-uuid Unique ID of the Tenant Connection
interface_type string - Interface Type of the Tenant Connection
name string - Name of the Tenant Connection
progress string - Progress of the Tenant Connection. ‘REQUESTED’ assures only having succeeded in registering approval request, which means this doesn’t deal with other sss status (‘cancelled’, ‘approved’, ‘denied’ ‘expired’, ‘approval_expired’).
tenant_id string non-hyph-uuid Tenant ID of the owner (UUID)

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "tenant_connection": {
    "approval_request_id": "1d5e9218-34e2-4ae2-872a-30726d46ac49",
    "connected_interface": {
      "id": "af64dfc4-3451-44e0-b2ce-f1972d89c6dc",
      "ip_address": "192.168.100.4",
      "virtual_ip_address": "192.168.100.3",
      "virtual_ip_properties": {
        "protocol": "vrrp",
        "vrid": 120
      }
    },
    "connected_network": {
      "id": "39dafb75-aa70-4079-9f69-eb6ffed00d7d",
      "subnet_cidr": "192.168.100.0/24",
      "tenant_id": "18a0e390d1534fd48f25f259add006c5"
    },
    "description": "",
    "id": "2b757ea7-f346-4297-a598-4d054bc0ae58",
    "interface_type": "firewall_interface",
    "name": "example A",
    "progress": "REQUESTED",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Update Tenant Connection

Update tenant connection.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • PUT

HTTP Request Path

{endpoint}/v2.0/tenant_connections/{tenant_connection_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
tenant_connection_id URI string hyph-uuid - Unique ID of the Tenant Connection yes
tenant_connection plain object Tenant Connection - - yes
description plain string - - Description of the Tenant Connection no
name plain string - - Name of the Tenant Connection no

Response

HTTP Response Code List

Response Code Description
200 OK
400 Bad Request
401 UnAuthorized
404 Not Found
409 Conflict
500 Internal Server Error

HTTP Response Parameters

Parameter Type Format Description
tenant_connection object Tenant Connection -
approval_request_id string hyph-uuid Approval Request ID
connected_interface object - Properties used for Connected Interface properties
id string hyph-uuid Resource id of the Interface which Connects the Tenant
ip_address string ipv4 IP Address
virtual_ip_address string ipv4 Virtual IP Address
virtual_ip_properties object - Properties used for virtual IP address
protocol string - Redundancy Protocol
vrid integer - VRRP group identifier
connected_network object - Properties used for Connected Network
id string hyph-uuid Network ID
subnet_cidr string cidr Subnet CIDR.
tenant_id string non-hyph-uuid Tenant ID of the Connected Network (UUID)
description string - Description of the Tenant Connection
id string hyph-uuid Unique ID of the Tenant Connection
interface_type string - Interface Type of the Tenant Connection
name string - Name of the Tenant Connection
progress string - Progress of the Tenant Connection. ‘REQUESTED’ assures only having succeeded in registering approval request, which means this doesn’t deal with other sss status (‘cancelled’, ‘approved’, ‘denied’ ‘expired’, ‘approval_expired’).
tenant_id string non-hyph-uuid Tenant ID of the owner (UUID)

Examples

Sample Request Body

{
  "tenant_connection": {
    "description": "",
    "name": "example A"
  }
}

Sample Response Body

{
  "tenant_connection": {
    "approval_request_id": "1d5e9218-34e2-4ae2-872a-30726d46ac49",
    "connected_interface": {
      "id": "af64dfc4-3451-44e0-b2ce-f1972d89c6dc",
      "ip_address": "192.168.100.4",
      "virtual_ip_address": "192.168.100.3",
      "virtual_ip_properties": {
        "protocol": "vrrp",
        "vrid": 120
      }
    },
    "connected_network": {
      "id": "39dafb75-aa70-4079-9f69-eb6ffed00d7d",
      "subnet_cidr": "192.168.100.0/24",
      "tenant_id": "18a0e390d1534fd48f25f259add006c5"
    },
    "description": "",
    "id": "2b757ea7-f346-4297-a598-4d054bc0ae58",
    "interface_type": "firewall_interface",
    "name": "example A",
    "progress": "REQUESTED",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Delete Tenant Connection

Delete tenant connection.

Synchronous / Asynchronous

  • Asynchronous

Request

HTTP Request Method

  • DELETE

HTTP Request Path

{endpoint}/v2.0/tenant_connections/{tenant_connection_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
tenant_connection_id URI string hyph-uuid - Unique ID of the Tenant Connection yes

Response

HTTP Response Code List

Response Code Description
204 No Content
400 Bad Request
401 UnAuthorized
404 Not Found
409 Conflict
500 Internal Server Error

HTTP Response Parameters

This operation does not receive a response body.

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

This operation does not receive a response body.