Public IPs#

The RackConnect v3.0 API enables you to add and remove public IP addresses from your RackConnect v3.0 cloud servers. These public IP addresses are being allocated out of your dedicated environment’s assigned public IP blocks.

Public IP address status values are as follows:

  • ADDING

  • ACTIVE

  • REMOVING

  • ADD_FAILED

  • REMOVE_FAILED

These values will appear in the response body of an API request.

List all public IP addresses#

GET /v3/public_ips

This operation lists details for all public IP addresses available to the specified tenant_id.

This table shows the possible response codes for this operation:

Response Code

Name

Description

200

OK

Success.

400

Bad request

The input was not in the correct format.

404

Not found

The requested item was not found.

500

Internal server error

An unexpected error has occurred.

Request#

Example List all public IP addresses: JSON request

curl --include \
 'https://dfw.rackconnect.api.rackspacecloud.com/v3/{tenant_id}/public_ips'

Response#

Example List all public IP addresses: JSON response

200 (OK)
Content-Type: application/json

[
    {
        "created": "2014-05-30T03:23:42Z",
        "cloud_server": {
            "cloud_network": {
                "cidr": "192.168.100.0/24",
                "created": "2014-05-25T01:23:42Z",
                "id": "07426958-1ebf-4c38-b032-d456820ca21a",
                "name": "RC-CLOUD",
                "private_ip_v4": "192.168.100.5",
                "updated": "2014-05-25T02:28:44Z"
            },
            "created": "2014-05-30T02:18:42Z",
            "id": "d95ae0c4-6ab8-4873-b82f-f8433840cff2",
            "name": "RCv3TestServer1",
            "updated": "2014-05-30T02:19:18Z"
        },
        "id": "2d0f586b-37a7-4ae0-adac-2743d5feb450",
        "public_ip_v4": "203.0.113.110",
        "status": "ACTIVE",
        "status_detail": null,
        "updated": "2014-05-30T03:24:18Z"
    }
]

Add one public IP#

POST /v3/public_ips

This operation provisions a new public IP address for the specified tenant_id.

This table shows the possible response codes for this operation:

Response Code

Name

Description

200

OK

Success.

400

Bad request

The input was not in the correct format.

500

Internal server error

An unexpected error has occurred.

Request#

Example Add one public IP: JSON request

{
    "cloud_server": {
        "id": "d95ae0c4-6ab8-4873-b82f-f8433840cff2"
    }
}

Response#

Example Add one public IP: JSON response

201 (Created)
Content-Type: application/json

{
    "created": "2014-05-30T03:23:42Z",
    "cloud_server": {
        "cloud_network": {
            "cidr": "192.168.100.0/24",
            "created": "2014-05-25T01:23:42Z",
            "id": "07426958-1ebf-4c38-b032-d456820ca21a",
            "name": "RC-CLOUD",
            "private_ip_v4": "192.168.100.5",
            "updated": "2014-05-25T02:28:44Z"
        },
        "created": "2014-05-30T02:18:42Z",
        "id": "d95ae0c4-6ab8-4873-b82f-f8433840cff2",
        "name": "RCv3TestServer1",
        "updated": "2014-05-30T02:19:18Z"
    },
    "id": "2d0f586b-37a7-4ae0-adac-2743d5feb450",
    "public_ip_v4": null,
    "status": "ADDING",
    "status_detail": null,
    "updated": null
}

List public IPs for a server#

GET /v3/public_ips/cloud_server_id

This operation lists all public IP addresses for the specified cloud_server_id.

This table shows the possible response codes for this operation:

Response Code

Name

Description

200

OK

Success.

400

Bad request

The input was not in the correct format.

404

Not found

The requested item was not found.

500

Internal server error

An unexpected error has occurred.

Request#

This table shows the URI parameters for the request:

Name

Type

Description

cloud_server_id

String (Optional)

Specifies the UUID of a cloud server.

Example List public IPs for a server: JSON request

curl --include \
 'https://dfw.rackconnect.api.rackspacecloud.com/v3/{tenant_id}/public_ips'

Response#

Example List public IPs for a server: JSON response

200 (OK)
Content-Type: application/json

[
    {
        "created": "2014-05-30T03:23:42Z",
        "cloud_server": {
            "cloud_network": {
                "cidr": "192.168.100.0/24",
                "created": "2014-05-25T01:23:42Z",
                "id": "07426958-1ebf-4c38-b032-d456820ca21a",
                "name": "RC-CLOUD",
                "private_ip_v4": "192.168.100.5",
                "updated": "2014-05-25T02:28:44Z"
            },
            "created": "2014-05-30T02:18:42Z",
            "id": "d95ae0c4-6ab8-4873-b82f-f8433840cff2",
            "name": "RCv3TestServer1",
            "updated": "2014-05-30T02:19:18Z"
        },
        "id": "2d0f586b-37a7-4ae0-adac-2743d5feb450",
        "public_ip_v4": "203.0.113.110",
        "status": "ACTIVE",
        "status_detail": null,
        "updated": "2014-05-30T03:24:18Z"
    }
]

List one public IP addresses#

GET /v3/public_ips/{public_IP_id}

This operation lists details for one public IP address identified by the specified public_IP_id.

This table shows the possible response codes for this operation:

Response Code

Name

Description

200

OK

Success.

400

Bad request

The input was not in the correct format.

404

Not found

The requested item was not found.

500

Internal server error

An unexpected error has occurred.

Request#

This table shows the URI parameters for the request:

Name

Type

Description

{public_IP_id}

String (Required)

Specifies the unique identifier of a public IP address.

Example List one public IP addresses: JSON request

curl --include \
 'https://dfw.rackconnect.api.rackspacecloud.com/v3/{tenant_id}/public_ips/{id}'

Response#

Example List one public IP addresses: JSON response

200 (OK)
Content-Type: application/json

{
    "created": "2014-05-30T03:23:42Z",
    "cloud_server": {
        "cloud_network": {
            "cidr": "192.168.100.0/24",
            "created": "2014-05-25T01:23:42Z",
            "id": "07426958-1ebf-4c38-b032-d456820ca21a",
            "name": "RC-CLOUD",
            "private_ip_v4": "192.168.100.5",
            "updated": "2014-05-25T02:28:44Z"
        },
        "created": "2014-05-30T02:18:42Z",
        "id": "d95ae0c4-6ab8-4873-b82f-f8433840cff2",
        "name": "RCv3TestServer1",
        "updated": "2014-05-30T02:19:18Z"
    },
    "id": "2d0f586b-37a7-4ae0-adac-2743d5feb450",
    "public_ip_v4": "203.0.113.110",
    "status": "ACTIVE",
    "status_detail": null,
    "updated": "2014-05-30T03:24:18Z"
}

Delete one public IP address#

DELETE /v3/public_ips/{public_IP_id}

This operation deletes the public IP address identified by the specified public_IP_id.

Request#

This table shows the URI parameters for the request:

Name

Type

Description

{public_IP_id}

String (Required)

Specifies the unique identifier of a public IP address.

This operation does not accept a request body.