1 of 6

API How-Tos

Cross Connect APIs allows contract owners, administrators, and authenticated users with the required permissions to create a cross connect and associate it with VDCs via the API.

Set User Privileges for Cross Connect

Prerequisite: You need administrative privileges to create and assign user privileges using the Cloud API.

To set user privileges via the Cloud API for managing Cross Connect, follow these steps:

Authenticate to the Cloud API using your API credentials.
Create a user using the POST /cloudapi/v6/um/users endpoint.
Set the following required parameters for the user: user's name, email address, and password.
Create a group using the POST /cloudapi/v6/um/groups endpoint.
Set createPcc privilege to true.
Assign the user to the created group using POST /cloudapi/v6/um/groups/{groupId}/users endpoint.

Note: Remember to provide the user ID in the request body as shown in the example: id: <userID>

Result: The Create Cross Connects privilege is granted to the user.

Create Cross Connect

Prerequisite: Only contract administrators, owners, and users with createPcc privilege can create and manage Cross Connects via the API. You can also set User privileges in the DCD. For more information, see Set User Privileges for Cross Connect.

Note: To connect a LAN to a Cross Connect, you must use the /lan endpoint. For more information about how to create LANs and associate them with a Cross Connect, see Associate Cross Connect with the VDC.

To create a Cross Connect via the API, perform a POST request with the name and description of the Cross Connect.

Request

   curl --location \
   --request POST 'https://api.ionos.com/cloudapi/v6/pccs' \
   --header 'Content-Type: application/json' \
   --header 'Authorization: Basic <auth-token>' \
   --data '{
            "properties": 
            {
             "name": "CrossConnect-Berlin",
             "description": "Cross Connect between datacenter '\''Berlin-W1'\'' and datacenter '\''Berlin-W2'\'' "
            }
           }'

Response

202 Successful operation

{
    "id": "f7a9c1-815a-486f-bb7b-3d0f2",
    "type": "pcc",
    "href": "https://api.ionos.com/cloudapi/v6/pccs/f7a9c1-815a-486f-bb7b-3d0f2",
    "metadata": {
        "createdDate": "2023-09-18T12:02:16Z",
        "createdBy": "xyz@ionos.com",
        "etag": "5409657baffecf",
        "lastModifiedDate": "2023-09-18T12:02:16Z",
        "lastModifiedBy": "xyz@ionos.com",
        "state": "BUSY"
    },
    "properties": {
        "name": "CrossConnect-Berlin",
        "description": "Cross Connect between datacenter 'Berlin-W1' and datacenter 'Berlin-W2' ",
        "peers": [],
        "connectableDatacenters": []
    }
}

For more information about the request and response fields, see Create a Cross Connect.

Connect a LAN to a Cross Connect

To associate a Cross Connect with your VDC and the configured private LAN, you can perform the following API calls:

POST creates a LAN and connects it to a Cross Connect in a single API call.
PUT or PATCH can be used to update the corresponding /lan resource.

Request

The following is an example of a PUT operation:

curl --location 
--request PUT 'https://api.ionos.com/cloudapi/v6/datacenters/{datacenter_UUID}/lans/2' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <auth-token>' \
--data '{    
    "properties": {        
        "pcc": "2e136690-1169-424f-ac4e-ead3fc02292b"    
                  }
        }'

Response

202 Successful operation

{
    "id": "2",
    "type": "lan",
    "href": "https://api.ionos.com/cloudapi/v6/datacenters/{datacenter_UUID}/lans/2",
    "metadata": {
        "etag": "d0f9c52b979bfe779e9368ca303bab88",
        "createdDate": "2023-09-11T12:00:35Z",
        "createdBy": "xyz@ionos.com",
        "createdByUserId": "0ea7c8-fd97-48ce-a375-6b2c38",
        "lastModifiedDate": "2023-09-20T11:48:03Z",
        "lastModifiedBy": "xyz@ionos.com",
        "lastModifiedByUserId": "0ea7c8-fd97-48ce-a375-6398fb",
        "state": "BUSY"
    },
    "properties": {
        "name": "LANCC",
        "ipFailover": [],
        "pcc": "2690-1169-424f-ac4e-222b",
        "ipv6CidrBlock": null,
        "public": false
    },
    "entities": {
        "nics": {
            "id": "2/nics",
            "type": "collection",
            "href": "https://api.ionos.com/cloudapi/v6/datacenters/{datacenter_UUID}/lans/2/nics"
        }
    }
}

For more information, see Create LANs and Partially modify LANs.

Update a Cross Connect

To modify a Cross Connect via the API, perform a PATCH request with the ID of the respective Cross Connect.

Request

   curl --location 
   --request PATCH 'https://api.ionos.com/cloudapi/v6/pccs/b229-d5df-4b97-bb23-e8b3' \
   --header 'Content-Type: application/json' \
   --header 'Authorization: Basic <auth-token>' \
   --data ' {
        "name": "My resource1",
        "description": "Cross Connect between datacenter '\''E'\'' and datacenter '\''B'\'' "
}
'

Response

202 Successful operation

{
    "id": "b229-d5df-4b97-bb23-e8b3",
    "type": "pcc",
    "href": "https://api.ionos.com/cloudapi/v6/pccs/b229-d5df-4b97-bb23-e8b3",
    "metadata": {
        "createdDate": "2023-10-11T13:29:16Z",
        "createdBy": "abc@ionos.com",
        "etag": "9913a87deffc",
        "lastModifiedDate": "2023-10-12T06:06:36Z",
        "lastModifiedBy": "abc@ionos.com",
        "state": "BUSY"
    },
    "properties": {
        "name": "My resource1",
        "description": "Cross Connect between datacenter 'E' and datacenter 'B' ",
        "peers": [],
        "connectableDatacenters": [
            {
                "id": "40ea-d887-4819-809b-41c6",
                "name": "Berlin-W1",
                "location": "de/txl"
            },
            {
                "id": "1ee4-7065-51ad-8yd6-cecf",
                "name": "VMAS",
                "location": "de/txl"
            },
            {
                "id": "12v2-7a56-4228-8990-b9fa",
                "name": "Berlin-W2",
                "location": "de/txl"
            }
        ]
    }
}

For more information about the request and response fields, see Partially modify Cross Connects.

Delete a Cross Connect

To delete a Cross Connect via the API, perform a DELETE request with the ID of the respective Cross Connect.

Request

   curl --location \
  --request DELETE 'https://api.ionos.com/cloudapi/v6/pccs/287acd-d1d2-40f0-bfb3-861d999' \
  --header 'Authorization: Basic <auth-token>'

Response

202 Successful operation

For more information about the request and response fields, see Delete Cross Connects.

Create Cross Connect

To create a Cross Connect via the API, perform a POST request with the name and description of the Cross Connect.

Request

   curl --location \
   --request POST 'https://api.ionos.com/cloudapi/v6/pccs' \
   --header 'Content-Type: application/json' \
   --header 'Authorization: Basic <auth-token>' \
   --data '{
            "properties": 
            {
             "name": "CrossConnect-Berlin",
             "description": "Cross Connect between datacenter '\''Berlin-W1'\'' and datacenter '\''Berlin-W2'\'' "
            }
           }'

Response

202 Successful operation

{
    "id": "f7a9c1-815a-486f-bb7b-3d0f2",
    "type": "pcc",
    "href": "https://api.ionos.com/cloudapi/v6/pccs/f7a9c1-815a-486f-bb7b-3d0f2",
    "metadata": {
        "createdDate": "2023-09-18T12:02:16Z",
        "createdBy": "xyz@ionos.com",
        "etag": "5409657baffecf",
        "lastModifiedDate": "2023-09-18T12:02:16Z",
        "lastModifiedBy": "xyz@ionos.com",
        "state": "BUSY"
    },
    "properties": {
        "name": "CrossConnect-Berlin",
        "description": "Cross Connect between datacenter 'Berlin-W1' and datacenter 'Berlin-W2' ",
        "peers": [],
        "connectableDatacenters": []
    }
}

For more information about the request and response fields, see Create a Cross Connect.

Connect a LAN to a Cross Connect

To associate a Cross Connect with your VDC and the configured private LAN, you can perform the following API calls:

POST creates a LAN and connects it to a Cross Connect in a single API call.
PUT or PATCH can be used to update the corresponding /lan resource.

Request

The following is an example of a PUT operation:

curl --location 
--request PUT 'https://api.ionos.com/cloudapi/v6/datacenters/{datacenter_UUID}/lans/2' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <auth-token>' \
--data '{    
    "properties": {        
        "pcc": "2e136690-1169-424f-ac4e-ead3fc02292b"    
                  }
        }'

Response

202 Successful operation

{
    "id": "2",
    "type": "lan",
    "href": "https://api.ionos.com/cloudapi/v6/datacenters/{datacenter_UUID}/lans/2",
    "metadata": {
        "etag": "d0f9c52b979bfe779e9368ca303bab88",
        "createdDate": "2023-09-11T12:00:35Z",
        "createdBy": "xyz@ionos.com",
        "createdByUserId": "0ea7c8-fd97-48ce-a375-6b2c38",
        "lastModifiedDate": "2023-09-20T11:48:03Z",
        "lastModifiedBy": "xyz@ionos.com",
        "lastModifiedByUserId": "0ea7c8-fd97-48ce-a375-6398fb",
        "state": "BUSY"
    },
    "properties": {
        "name": "LANCC",
        "ipFailover": [],
        "pcc": "2690-1169-424f-ac4e-222b",
        "ipv6CidrBlock": null,
        "public": false
    },
    "entities": {
        "nics": {
            "id": "2/nics",
            "type": "collection",
            "href": "https://api.ionos.com/cloudapi/v6/datacenters/{datacenter_UUID}/lans/2/nics"
        }
    }
}

For more information, see Create LANs and Partially modify LANs.