Breadcrumbs

Director API - Get

Service name: <MachineName>-Director (one per machine).

General

Top-level director state and persistent state endpoints.

State [GET]

State

Retrieves the current state of the Director.

No parameters — message is always {}.



Value

State

 OBJECT

The current state of the Director.
Example - State

Request (you send)

JSON
{
  "Type": "Get",
  "Target": "<Service>",
  "RespondTo": "<Service>",
  "Name": "State"
}
JSON
{}

Response (you receive)

JSON
{
  "Type": "Update",
  "Target": "<Service>",
  "RespondTo": "<Service>",
  "Name": "State"
}
JSON
{
  "State": {
    "directorId": "<DirectorID>",
    "daemonId": "<DaemonID>",
    "systemDebugMode": {
      "devMode": false,
      "processDebugMode": false,
      "showVerboseLogs": false
    }
  }
}
Persistent State [GET]

Persistent State

Retrieves the persistent state of the Director.

No parameters — message is always {}.



Value

Persistent State

 OBJECT

The persistent state of the Director.
Example - Persistent State

Request (you send)

JSON
{
  "Type": "Get",
  "Target": "<Service>",
  "RespondTo": "<Service>",
  "Name": "PersistentState"
}
JSON
{}

Response (you receive)

JSON
{
  "Type": "Update",
  "Target": "<Service>",
  "RespondTo": "<Service>",
  "Name": "PersistentState"
}
JSON
{
  "PersistentState": {
    "buildDate": "<BuildDate>",
    "appVersion": "<AppVersion>",
    "hostname": "<Hostname>",
    "installDirectory": "<InstallDirectory>"
  }
}
External Links [GET]

Retrieves the external links of the Director.

No parameters — message is always {}.



Value

External Links

 OBJECT

The external links of the Director.
Example - External Links

Request (you send)

JSON
{
  "Type": "Get",
  "Target": "<Service>",
  "RespondTo": "<Service>",
  "Name": "ExternalLinks"
}
JSON
{}

Response (you receive)

JSON
{
  "Type": "Update",
  "Target": "<Service>",
  "RespondTo": "<Service>",
  "Name": "ExternalLinks"
}
JSON
{
  "ExternalLinks": {
    "faq": "https://www.pixotope.com/support/faq",
    "login": "https://prod.pixotope.cloud/customer/user/signin",
    "eula": "https://www.pixotope.com/eula",
    "privacyAmericas": "https://www.pixotope.com/privacy-policy-americas",
    "privacy": "https://www.pixotope.com/privacy-policy",
    "subscription": "https://www.pixotope.com/subscription-agreement",
    "colorMatching": "https://pixotope.com/help/color-matching",
    "unrealCommandDocumentation": "https://pixotope.com/help/command-line-arguments",
    "giveFeedback": "https://www.pixotope.com/feedback",
    "pixotopeHelpCenter": "https://help.pixotope.com/",
    "assetHubHelpCenter": "https://pixotope.com/help/asset-hub",
    "zendesk": "https://pixotope.zendesk.com/agent/dashboard",
    "serverFailoverHelp": "https://pixotope.com/help/server-failover",
    "pixotopeAutomaticDelayLink": "https://pixotope.com/help/automatic-delay-detection",
    "engineColorSpace": "https://pixotope.com/help/editor-working-color-space"
  }
}