Get the profile schema

curl http://localhost:3000/schema/profiles \
     -u "<username>:<password>"

{
  "schema": {
    "uiProps": {
      "description": "UI",
      "layout": "node_modules/@itential/pronghorn-core/ui/views/layout.jade",
      "home": "node_modules/@itential/pronghorn-core/ui/views/home.jade",
      "login": "node_modules/@itential/pronghorn-core/ui/views/login.jade",
      "profile": "node_modules/@itential/pronghorn-core/ui/views/profile.jade",
      "fav_icon": "node_modules/@itential/pronghorn-core/ui/img/favicon.ico"
    },
    "authenticationProps": {
      "description": "Authentication",
      "logoutTime": 20,
      "principalTimeout": 20,
      "relayStateTimeout": 600,
      "uniqueSession": false,
      "admins": [
        {
          "provenance": "Local AAA",
          "group": "admin"
        }
      ],
      "cookieName": "pronghorn_token",
      "brokerPrincipal": false
    },
    "expressProps": {
      "description": "Express Server",
      "cacheControl": false,
      "timeout": 300000,
      "access_control_allow_origin": "*",
      "express_http": {
        "enable": false,
        "port": 1
      },
      "express_https": {
        "enable": true,
        "port": 1,
        "key": "/opt/pronghorn/current/keys/key.pem",
        "passphrase": "string",
        "cert": "/opt/pronghorn/current/keys/cert.pem",
        "secureProtocol": "TLSv1_2_method",
        "tlsMinVersion": "TLSv1.3",
        "tlsMaxVersion": "TLSv1.3",
        "ciphers": "ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256",
        "client_reneg_limit": 1,
        "client_reneg_window": 600
      },
      "allowedHttpOptionalVerbs": [
        "ACL"
      ]
    },
    "loggerProps": {
      "description": "Logging",
      "log_directory": "/var/log/pronghorn",
      "log_filename": "pronghorn.log",
      "log_max_file_size": 1048576,
      "log_max_files": 100,
      "log_level": "error",
      "console_level": "error",
      "log_format_json": false,
      "console_format_json": false,
      "webserver": {
        "log_directory": "/var/log/pronghorn",
        "log_filename": "webserver.log"
      },
      "syslog": {
        "level": "debug",
        "host": "localhost",
        "port": 514,
        "protocol": "udp4",
        "facility": "local0",
        "type": "5424",
        "path": "/dev/log",
        "pid": "process.pid",
        "localhost": "localhost",
        "app_name": "process.title",
        "eol": "CR",
        "format_json": false
      }
    },
    "redisProps": {
      "host": "127.0.0.1",
      "port": 6379
    },
    "auditProps": {
      "description": "Audit",
      "audit": true,
      "brokerValidation": true
    },
    "pathProps": {
      "description": "string",
      "encrypted": true
    },
    "alarmProps": [
      {
        "description": "string",
        "ip": "127.0.0.1",
        "community": "public",
        "properties": {
          "retries": 1,
          "timeout": 5000,
          "transport": "udp4",
          "trapPort": 162,
          "version": "V1"
        },
        "type": "trap"
      }
    ],
    "id": "profile1",
    "services": [
      "WorkflowBuilder"
    ],
    "description": "An IAP Profile",
    "adapterStrategy": {
      "device": {
        "adapterTypes": [
          "NSO"
        ],
        "exceptions": {
          "runCommand": "string"
        }
      }
    },
    "systemProps": {
      "shutdownTimeout": 3,
      "servicesBlacklist": [
        "Local AAA"
      ],
      "launchDelay": 5,
      "launchTimeout": 60,
      "serviceHealthCheckInterval": 1,
      "serviceHealthCheckUnhealthyThreshold": 1,
      "deadProcessCheck": false,
      "deadProcessCheckInterval": 5,
      "deadProcessMaxPeriod": 15,
      "externalRequestTimeout": 5,
      "deviceCountPollingInterval": 24,
      "serverIdStrategy": "mac:port",
      "eventWorkerCount": 3,
      "transformationWorkerCount": 3,
      "taskWorkerThreadCount": 1,
      "taskWorkerRateLimit": 0,
      "taskWorkerRateLimitPeriod": 1
    },
    "prebuiltProps": {
      "repoConfigs": {
        "@itentialopensource": {
          "enabled": true,
          "type": "gitlab",
          "hostname": "gitlab.com",
          "path": "itentialopensource/pre-built-automations",
          "credentials": {
            "token": "uTc_P4pnMAEsLbQHmyOt"
          }
        }
      }
    },
    "integrationProps": {
      "threadCount": 5,
      "timeout": 15000
    },
    "retryStrategy": {
      "maxRetries": 5,
      "retryResetTimer": 30000
    },
    "serviceDirectory": "string"
  },
  "decorators": [
    {
      "type": "encryption",
      "pointer": "/redisProps/password"
    }
  ]
}

Returns the profile schema.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Response

Contains the schema for profiles.

schemaobject

The root schema comprises the entire JSON document.

decoratorslist of objects

Errors

500

Internal Server Error