Registering your Connector Appliance unattended
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 unattended registration process has the following steps:
-
Generate a secure client in Citrix Cloud by referring to Getting started.
-
Generate a valid authorization token
-
Call the
/unattendedRegistrationendpoint on the Connector Appliance with the authorization of the token and the details of the secure client.
See also Registering your Connector Appliance with Citrix Cloud.
Request
POST /unattendedRegistration HTTP/1.1
Content-Type: application/json
Accept: */*
Authorization: Bearer <token>
Host: <connector-appliance-ip-address>
{
"applianceName": "<connector-appliance-name>",
"clientId": "<secure-client-id>",
"clientSecret": "<secure-client-secret-base64>",
"deployment": "production",
"resourceLocationId": "<resource-location-id>"
}
<!--NeedCopy-->
-
applianceNameis a fully qualified domain name (FQDN) -
clientIdis the UUID reference of the secure client. -
clientSecretshould be in the form of a base64 string as shown when first creating a secure client. -
deploymentdefaults toproduction, useproductionjpfor registering to the Japan region. -
resourceLocationIdis a UUID representing the resource location that the Connector Appliance is to be registered to, a default is chosen if missing.
Responses
Success
HTTP/1.1 200 OK
...
{
"status": "Registered"
}
<!--NeedCopy-->
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.
Missing authentication details
HTTP/1.1 401 Unauthorized
...
Content-Type: application/json; charset=utf-8
...
{
"type": "https://errors-api.cloud.com/common/authentication",
"detail": "Missing authentication details",
"parameters": [
{
"name": "reason",
"value": "missing"
}
]
}
<!--NeedCopy-->
Check that you have a valid authorization token in your request.
Invalid authentication details
HTTP/1.1 401 Unauthorized
...
Content-Type: application/json; charset=utf-8
...
{
"type": "https://errors-api.cloud.com/common/authentication",
"detail": "Invalid authentication details",
"parameters": [
{
"name": "reason",
"value": "invalid"
}
]
}
<!--NeedCopy-->
Check that you have a valid authorization token in your request and that it has not expired.
Invalid appliance name
HTTP/1.1 400 Bad Request
...
Content-Type: application/json; charset=utf-8
...
{
"type": "https://errors-api.cloud.com/common/invalidString",
"detail": "Field \"applianceName\" has an invalid value.",
"parameters": [
{
"name": "property",
"value": "applianceName"
}
]
}
<!--NeedCopy-->
Ensure that the given applianceName field is a valid fully qualified domain name (FQDN).