> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.itential.com/itential-platform/2023-2/api-reference/profiles/export-profile/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itential.com/_mcp/server.

# Export a single profile

GET http://localhost:3000/profiles/{id}/export

Exports a single profile in the current Itential Platform.

Reference: https://docs.itential.com/itential-platform/6/api-reference/profiles/export-profile

## Authentication

- `Authorization` header (basic auth, required) — Basic authentication of the form `Basic <base64(username:password)>`.

## Request

### Path parameters

- `id` (string, required) — Contains the id for the selected profile.

## Response

### 200

Contains the metadata and data of a profile.

- `applicationProps` (object, required)
  - `directory` (string, required, default: /opt/pronghorn/current/node_modules) — The location of the node_modules directory.
  - `description` (string, optional, default: Application)
- `uiProps` (object, required)
  - `layout` (string, required)
  - `home` (string, required)
  - `login` (string, required)
  - `profile` (string, required)
  - `fav_icon` (string, required)
  - `description` (string, optional, default: UI)
- `authenticationProps` (object, required)
  - `uniqueSession` (boolean, required, default: false) — When uniqueSession is set to true, only one session may be enabled for a given user.
  - `admins` (list of object, required) — Members of these groups will be implicitly assigned with admin permissions
    - `provenance` (string, required, default: ) — The name of the AAA adapter in which the groups reside.
    - `group` (string, required, default: ) — The name of a user group which will have Pronghorn user management capabilities.
  - `sso` (object, required) — The configuration settings for single sign on
    - `enabled` (boolean, required, default: false) — A boolean flag indicating if single sign on is active
    - `config` (string, required, default: ) — Name of the SSO configuration to be used
  - `description` (string, optional)
  - `logoutTime` (integer, optional, default: 60) — The maximum number of time IAP has to make an api call before the user is logged out, in minutes.
  - `relayStateTimeout` (integer, optional) — The time before an SSO login callback expires, in seconds.
  - `cookieName` (string, optional, default: token) — The name used by Pronghorn to identify cookies for user session data
  - `brokerPrincipal` (boolean, optional, default: false) — When brokerPrincipal is set to true, the AAA adapter will be responsible for creating a principal.
- `expressProps` (object, required)
  - `express_http` (object, required)
    - `enable` (boolean, required, default: false) — A boolean flag indicating whether Pronghorn will listen for incoming HTTP requests.
    - `port` (integer, required)
  - `express_https` (object, required)
    - `enable` (boolean, required, default: false) — A boolean flag indicating whether Pronghorn will listen for incoming HTTPS requests.
    - `port` (integer, required)
    - `key` (string, required, default: /opt/pronghorn/current/keys/key.pem) — The server's private key to use for all https transactions. If the private key is encrypted with a passphrase, you should also include the express_https.passphrase property.
    - `cert` (string, required, default: /opt/pronghorn/current/keys/cert.pem) — The server's public certificate to use for all HTTPS transactions.
    - `client_reneg_limit` (integer, required, default: 1) — The maximum number of client renegotiations allowed per renegotiation window.
    - `client_reneg_window` (integer, required, default: 600) — The renegotiation window allows a limited number of client renegotiation requests within a configured number of seconds.
    - `passphrase` (string, optional) — The passphrase for the server's private key. You should only include this property if the private key is encrypted with a passphrase.
    - `secureProtocol` (enum, optional) — The secureProtocol can be used to configure the set of allowed SSL/TLS protocol version. Ignored when either tlsMinVersion or tlsMaxVersion is given..
      - Allowed values: `TLS_method`, `TLSv1_2_method`, `TLSv1_1_method`, `TLSv1_method`
    - `tlsMinVersion` (enum, optional) — Minimum permitted TLS version. Overrides secureProtocol.
      - Allowed values: `TLSv1.3`, `TLSv1.2`, `TLSv1.1`, `TLSv1`
    - `tlsMaxVersion` (enum, optional) — Maximum permitted TLS version. Overrides secureProtocol.
      - Allowed values: `TLSv1.3`, `TLSv1.2`, `TLSv1.1`, `TLSv1`
    - `ciphers` (string, optional, default: ) — The set of ciphers to allow when establishing an encrypted session.
  - `description` (string, optional, default: Express Server)
  - `cacheControl` (boolean, optional, default: false) — A boolean flag indicating whether Pronghorn will send the Cache-Control header. This can be useful in environments that leverage caching proxy servers.
  - `timeout` (integer, optional, default: 300000) — The maximum number of milliseconds Pronghorn has to respond to a request before a timeout will be returned to the client.
  - `access_control_allow_origin` (string, optional, default: *) — The configured domain name for the Access-Control-Allow-Origin header used for security.
  - `allowedHttpOptionalVerbs` (list of enum, optional, default: []) — An array of optional HTTP verbs that are allowed to be used in requests to IAP
    - Allowed values: `ACL`, `BIND`, `CHECKOUT`, `CONNECT`, `COPY`, `LINK`, `LOCK`, `MERGE`, `MKACTIVITY`, `MKCALENDAR`, `MKCOL`, `MOVE`, `M-SEARCH`, `NOTIFY`, `PROPFIND`, `PROPPATCH`, `PURGE`, `REBIND`, `REPORT`, `SEARCH`, `SUBSCRIBE`, `TRACE`, `UNBIND`, `UNLINK`, `UNLOCK`, `UNSUBSCRIBE`
- `loggerProps` (object, required)
  - `log_directory` (string, required, default: /var/log/pronghorn) — The directory to store Pronghorn log files.
  - `log_filename` (string, required, default: pronghorn.log) — The name of the current Pronghorn log file.
  - `log_max_file_size` (integer, required, default: 1048576) — The maximum size of each Pronghorn log file in bytes.
  - `log_max_files` (integer, required, default: 100) — The maximum number of log files maintained on the server.
  - `log_level` (enum, required)
    - Allowed values: `error`, `warn`, `info`, `debug`, `trace`, `spam`
  - `console_level` (enum, required)
    - Allowed values: `error`, `warn`, `info`, `debug`, `trace`, `spam`
  - `description` (string, optional, default: Logger Settings)
  - `log_format_json` (boolean, optional, default: false) — If true, log entries will be written in JSON format. Otherwise, log entries will be written in plaintext.
  - `console_format_json` (boolean, optional, default: false) — If true, console logs will be written in JSON format. Otherwise, they will be written in plaintext.
  - `webserver` (object, optional) — Determines how to set up the web server access log.
    - `log_directory` (string, optional, default: /var/log/pronghorn) — The directory to store web server access log files.
    - `log_filename` (string, optional, default: webserver.log) — The name for the web server access log file.
  - `syslog` (object, optional) — Allows Pronghorn to send log messages to a local or remote syslog daemon.
    - `level` (enum, optional, default: warning)
      - Allowed values: `debug`, `info`, `warning`, `error`
    - `host` (string, optional, default: localhost) — The host running syslogd.
    - `port` (integer, optional, default: 514) — The port on the host that syslog is running on.
    - `protocol` (enum, optional, default: udp4) — The network protocol to log over. Can be one of tcp4, udp4, unix or unix-connect.
      - Allowed values: `tcp4`, `udp4`, `unix`, `unix-connect`
    - `facility` (string, optional, default: local0) — The syslog facility to use.
    - `type` (enum, optional, default: BSD) — The type of syslog protocol to use. Possible values are BSD and 5424.
      - Allowed values: `BSD`, `5424`
    - `path` (string, optional, default: ) — The path to the syslog dgram socket (i.e. /dev/log or /var/run/syslog for OS X). If path is used, host, port and protocol do not need to be configured.
    - `pid` (string, optional, default: process.pid) — Process identifier (PID) of the process that log messages are coming from (Default is process.pid).
    - `localhost` (string, optional, default: ) — The host to indicate that log messages are coming from.
    - `app_name` (string, optional, default: ) — The name of the application.
    - `eol` (string, optional, default: ) — The end of line character to be added to the end of the message.
    - `format_json` (boolean, optional, default: false) — If true, syslog logs will be written in JSON format. Otherwise, they will be written in plaintext.
- `redisProps` (object or object, required)
  - object
    - `host` (string, required) — The IP or hostname of the server running the Redis service.
    - `port` (integer, required)
  - object
    - `sentinels` (list of object, required) — The list of Redis hosts for sentinel configuration.
      - `host` (string, optional)
      - `port` (integer, optional)
    - `name` (string, required) — The name of the master node in the Redis sentinel group.
- `auditProps` (object, required)
  - `audit` (boolean, required)
  - `brokerValidation` (boolean, required)
  - `description` (string, optional)
- `pathProps` (object, required)
  - `encrypted` (boolean, required, default: true) — A boolean flag indicating Pronghorn core is encrypted.
  - `description` (string, optional, default: Path Properties)
- `alarmProps` (list of object, required)
  - `ip` (string, required, default: 127.0.0.1) — The IP address of the remote alarm receiver. FQDNs are also supported in this field.
  - `community` (string, required, default: public) — The SNMP community to apply to the outgoing trap or inform.
  - `properties` (object, required) — Remote SNMP destination config.
  - `type` (enum, required, default: trap) — The type can be configured as either a trap or inform.
    - Allowed values: `trap`, `inform`
  - `description` (string, optional, default: Alarm)
- `id` (string, required)
- `services` (list of string, required)
- `description` (string, required)
- `adapterStrategy` (object, required)
  - `device` (object, required) — Defines the order in which southbound systems are called.
    - `adapterTypes` (list of enum, required) — A list of adapter types that manages the devices.
      - Allowed values: `NSO`, `AutomationGateway`
    - `exceptions` (object, optional, default: {"runCommand":""}) — An override for the runCommand's preference to a southbound system.
      - `runCommand` (string, required, default: ) — Runs a command on a device.
- `systemProps` (object, required) — Properties used to configure IAP process.
  - `shutdownTimeout` (integer, optional) — The amount of time a service should wait before shutting down, in seconds.
  - `servicesBlacklist` (list of string, optional) — An array of services that blocks CRUD operation access for each service listed.
  - `launchDelay` (integer, optional) — The application/adapter launch delay, in seconds.
  - `launchTimeout` (integer, optional) — The application/adapter launch timeout, in seconds.
  - `serviceHealthCheckInterval` (integer, optional, default: 5) — How often to update service health, measured in seconds.
  - `serviceHealthCheckUnhealthyThreshold` (integer, optional, default: 3) — Health data staleness threshhold, measured in number of missed health checks. Services which fail to report health data will be assumed to be offline.
  - `deadProcessCheck` (boolean, optional, default: false) — Enable/disable IAP check for dead applications/adapters.
  - `deadProcessCheckInterval` (integer, optional, default: 5) — How often to check if application/adapter stopped sending healthcheck pings, in seconds.
  - `deadProcessMaxPeriod` (integer, optional, default: 15) — Maximum time period for application/adapter without sending healthcheck ping, in seconds.
  - `externalRequestTimeout` (integer, optional, default: 5) — The timeout for external API requests, in seconds.
  - `deviceCountPollingInterval` (integer, optional, default: 24) — The interval for how often IAP polls for the number of devices, in hours.
  - `eventWorkerCount` (integer, optional, default: 3) — The number of worker threads available for event processing.
  - `transformationWorkerCount` (integer, optional, default: 3) — The number of worker threads available for transformation processing.
- `prebuiltProps` (object, required)
  - `repoConfigs` (object, required) — The configurations used to fetch Prebuilts from different repositories.
    - `@itentialopensource` (object, optional)
      - `enabled` (boolean, optional) — A flag that denotes if the repository configuration is connected
      - `type` (enum, optional) — The type of Repository
        - Allowed values: `gitlab`
      - `hostname` (string, optional) — The hostname of the Respository endpoint
      - `path` (string, optional) — The path of the Repository endpoint
      - `credentials` (object, optional)
        - `token` (string, optional) — An access token used to make HTTP requests
- `integrationProps` (object, optional)
  - `threadCount` (integer, required, default: 5) — The number of threads available for API requests.
  - `timeout` (integer, required, default: 15000) — The number of milliseconds until an integration request times out.
- `retryStrategy` (object, optional) — Properties used to configure the strategy services use on crash.
  - `maxRetries` (integer, required, default: 10) — Specifies the amount of times services will retry on crash before stopping.
  - `retryResetTimer` (integer, required, default: 60000) — Specifies the amount of times between each retry before the count will reset in milliseconds.

## Errors

### 500 Internal Server Error

Error response from API

- `any`

## Examples

**Response**

```json
{
  "applicationProps": {
    "directory": "/opt/pronghorn/current/node_modules",
    "description": "Application"
  },
  "uiProps": {
    "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",
    "description": "UI"
  },
  "authenticationProps": {
    "uniqueSession": false,
    "admins": [
      {
        "provenance": "Local AAA",
        "group": "admin"
      }
    ],
    "sso": {
      "enabled": false,
      "config": "okta"
    },
    "description": "Authentication",
    "logoutTime": 20,
    "relayStateTimeout": 600,
    "cookieName": "pronghorn_token",
    "brokerPrincipal": false
  },
  "expressProps": {
    "express_http": {
      "enable": false,
      "port": 1
    },
    "express_https": {
      "enable": true,
      "port": 1,
      "key": "/opt/pronghorn/current/keys/key.pem",
      "cert": "/opt/pronghorn/current/keys/cert.pem",
      "client_reneg_limit": 1,
      "client_reneg_window": 600,
      "passphrase": "string",
      "secureProtocol": "TLSv1_2_method",
      "tlsMinVersion": "TLSv1.3",
      "tlsMaxVersion": "TLSv1.3",
      "ciphers": "ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256"
    },
    "description": "Express Server",
    "cacheControl": false,
    "timeout": 300000,
    "access_control_allow_origin": "*",
    "allowedHttpOptionalVerbs": [
      "ACL"
    ]
  },
  "loggerProps": {
    "log_directory": "/var/log/pronghorn",
    "log_filename": "pronghorn.log",
    "log_max_file_size": 1048576,
    "log_max_files": 100,
    "log_level": "error",
    "console_level": "error",
    "description": "Logging",
    "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": {
    "audit": true,
    "brokerValidation": true,
    "description": "Audit"
  },
  "pathProps": {
    "encrypted": true,
    "description": "Path Properties"
  },
  "alarmProps": [
    {
      "ip": "127.0.0.1",
      "community": "public",
      "properties": {
        "retries": 1,
        "timeout": 5000,
        "transport": "udp4",
        "trapPort": 162,
        "version": "V1"
      },
      "type": "trap",
      "description": "Alarm"
    }
  ],
  "id": "profile1",
  "services": [
    "WorkflowBuilder"
  ],
  "description": "An IAP Profile",
  "adapterStrategy": {
    "device": {
      "adapterTypes": [
        "NSO"
      ],
      "exceptions": {
        "runCommand": ""
      }
    }
  },
  "systemProps": {
    "shutdownTimeout": 3,
    "servicesBlacklist": [
      "Local AAA"
    ],
    "launchDelay": 5,
    "launchTimeout": 60,
    "serviceHealthCheckInterval": 5,
    "serviceHealthCheckUnhealthyThreshold": 3,
    "deadProcessCheck": false,
    "deadProcessCheckInterval": 5,
    "deadProcessMaxPeriod": 15,
    "externalRequestTimeout": 5,
    "deviceCountPollingInterval": 24,
    "eventWorkerCount": 3,
    "transformationWorkerCount": 3
  },
  "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
  }
}
```

**SDK Code**

```python
import requests

url = "http://localhost:3000/profiles/id/export"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'http://localhost:3000/profiles/id/export';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3000/profiles/id/export"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/profiles/id/export")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("http://localhost:3000/profiles/id/export")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'http://localhost:3000/profiles/id/export');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("http://localhost:3000/profiles/id/export");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:3000/profiles/id/export")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```