Registering your Connector Appliance

Last published : Oct 31, 2026
After installing and starting your Connector Appliance, you must register it with Citrix Cloud to provide a channel for communication between Citrix Cloud and your resource locations.
The registration process has the following steps:
  1. Get a verification code from the Connector Appliance.
    You can use the Connector Appliance API to get the registration code.
  2. Provide the verification code to Citrix Cloud on the Resource Location page.
    For more information, see the product documentation.
See also Registering your Connector Appliance with Citrix Cloud unattended

Get the registration code

Use this API call to name your Connector Appliance and get a registration code that you provide to Citrix Cloud.

Request

The ID of the resource location you want to add the Connector Appliance to is located on the Resource Locations page in Citrix Cloud. Click the ID link underneath the resource location name.
The Connector Appliance name must be unique for the resource location.
deployment defaults to production, use productionjp for registering to the Japan region or use productiongov for registering to the Government region.
POST /registration HTTP/1.1
Content-Type: application/json
Accept: */*
Host: <connector-appliance-ip-address>

{
  "name": "<connector-appliance-name>",
  "deployment": "production",
  "resource_location_id": "<resource-location-id>"
}

Responses

Success

HTTP/1.1 201 Created
...

{
    "code": "XXXXXXXX",
    "pollingInterval": 30,
    "status": "Unregistered",
    "verificationUrl": "https://citrix.cloud.com/identity/api-access/product-registrations",
    "expiryTimestamp": "<timestamp>"
}
Make a note of the value of code and paste it into the Add a Connector Appliance dialog in the Citrix Cloud console. For more information, see the product documentation.

Connector already registered

HTTP/1.1 500 Internal Server Error
...

{
    "type": "https://errors-api.cloud.com/connapp/error",
    "detail": "An error has occurred."
}

Get connector status

Use this call to check whether the Connector Appliance is registered with Citrix Cloud.

Request

GET /registration HTTP/1.1
Accept: */*
Host: <connector-appliance-ip-address>
Connection: keep-alive

Response

HTTP/1.1 200 OK
...
{
    "status": "Registered"
}
The value of status can be either "Registered" or "Unregistered". The Connector Appliance must be registered with a Resource Location in Citrix Cloud to connect your environment to your Citrix Cloud services.