> For the complete documentation index, see [llms.txt](https://docs.devolutions.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.devolutions.net/powershell-universal/powershell-commands/new-udendpoint.md).

# New-UDEndpoint

New-UDEndpoint defines a PowerShell Universal API or scheduled script endpoint that runs server side code and can require specific roles.

## SYNOPSIS

Creates a scheduled endpoint with a dashboard.

## SYNTAX

### Generic (Default)

```
New-UDEndpoint [-ArgumentList <Object[]>] [-Id <String>] [-Role <String[]>]
 [<CommonParameters>]
```

### Endpoint

```
New-UDEndpoint -Endpoint <ScriptBlock> [-ArgumentList <Object[]>] [-Id <String>] [-Role <String[]>]
 [<CommonParameters>]
```

### Scheduled

```
New-UDEndpoint -Endpoint <ScriptBlock> [-ArgumentList <Object[]>] [-Id <String>] -Schedule <EndpointSchedule>
 [-Role <String[]>] [<CommonParameters>]
```

### JavaScript

```
New-UDEndpoint -JavaScript <String> [-ArgumentList <Object[]>] [-Id <String>] [-Role <String[]>]
 [<CommonParameters>]
```

## DESCRIPTION

Creates a scheduled endpoint with a dashboard.

## EXAMPLES

### Example 1

```powershell
$Schedule = New-UDEndpointSchedule 10 -Second
New-UDEndpoint -Schedule $Schedule -Endpoint {
    $Cache:Random = Get-Random
}
New-UDButton -Text "Get Random" -OnClick {
    Show-UDToast $Cache:Random
}
```

Scheduled Endpoints|Caches a random value every ten seconds

## PARAMETERS

### -ArgumentList

Not required.

```yaml
Type: Object[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Endpoint

The endpoint to run on the schedule.

```yaml
Type: ScriptBlock
Parameter Sets: Endpoint, Scheduled
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Id

The ID of the endpoint.

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Role

Not used.

```yaml
Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Schedule

The schedule to run for the endpoint. Use New-UDEndpointSchedule to create a schedule object.

```yaml
Type: EndpointSchedule
Parameter Sets: Scheduled
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -JavaScript

The JavaScript code to run on the endpoint.

```yaml
Type: String
Parameter Sets: JavaScript
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable, and -ProgressAction. For more information, see [about\_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### None

## OUTPUTS

### System.Object

## NOTES

## RELATED LINKS


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.devolutions.net/powershell-universal/powershell-commands/new-udendpoint.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.