---
title: "POST /api/v1/provider-links/{id}/agents/bash-install-script-with-onboarding"
method: POST
path: "/api/v1/provider-links/{id}/agents/bash-install-script-with-onboarding"
tags: ["ProviderLinks"]
---

# POST /api/v1/provider-links/{id}/agents/bash-install-script-with-onboarding

`POST /api/v1/provider-links/{id}/agents/bash-install-script-with-onboarding`

## Request

- Base URL: `https://api.immy.bot` (the document declares no server; this is the origin it was published from)
- URL: `https://api.immy.bot/api/v1/provider-links/{id}/agents/bash-install-script-with-onboarding`
- Auth: none declared

## Path parameters

- `id` integer, required

## Request body

- GetBashInstallScriptParametersWithOnboardingOptions
  - `platform` 'Windows' | 'Mac' | 'Linux': The string or integer value may be used. Windows = 1, Mac = 2, Linux = 3
  - `targetExternalClientId` string, nullable, required
  - `onboardingOptions` AgentOnboardingOptions, required
    - `automaticallyOnboard` boolean
    - `onboardingCorrelationId` string, nullable
    - `onboardingSessionRebootPreference` 'Normal' | 'Suppress' | 'Prompt' | 'Force': The string or integer value may be used. Normal = 0, Suppress = 1, Prompt = 2, Force = -1
    - `onboardingSessionPromptTimeoutAction` 'Reboot' | 'Suppress' | 'FailSession': The string or integer value may be used. Reboot = 0, Suppress = 1, FailSession = 2
    - `onboardingSessionAutoConsentToReboots` boolean
    - `onboardingSessionPromptTimeoutMinutes` integer
    - `onboardingSessionSendFollowUpEmail` boolean
    - `primaryPersonId` integer, nullable
    - `additionalPersonIds` integer[], nullable
    - `tags` integer[], nullable
    - `isDevLab` boolean

## Response `200`

OK

- IScript
  - `scriptLanguage` 'CommandLine' | 'PowerShell': The string or integer value may be used. CommandLine = 1, PowerShell = 2
  - `script` string, nullable
  - `timeout` integer

---

[API](https://skmtc.dev/immy/apis/immy-bot-api.md) · [All operations](https://skmtc.dev/immy/apis/immy-bot-api/llms.txt) · [OpenAPI document](https://skmtc.dev/immy/apis/immy-bot-api/revisions/559d0e4b39d3?raw)