Get-NectarEndpoint
- 21 Aug 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Get-NectarEndpoint
- Updated on 21 Aug 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Returns a list of Nectar DXP endpoints
Syntax
Get-NectarEndpoint
-SearchQuery <String>
-OrderByField <String>
-OrderDirection <String>
-TenantName <String>
-PageSize <Int32>
-ResultSize <Int32>
Examples
Example 1
Get-NectarEndpoint
Returns the first 100000 endpoints
Example 2
Get-NectarEndpoint -ResultSize 100
Returns the first 100 endpoints
Example 3
Get-NectarEndpoint -SearchQuery US
Returns all endpoints that have US in any of the data fields
Parameters
-SearchQuery <String>
A string to search for. Will search for match against all fields
| Parameter | Value |
|---|---|
| Required | false |
| Position | 1 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-OrderByField <String>
Sort the output by the selected field
| Parameter | Value |
|---|---|
| Required | false |
| Position | 2 |
| Required | false |
| Default Value | id |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-OrderDirection <String>
Sort ordered output in ascending or descending order
| Parameter | Value |
|---|---|
| Required | false |
| Position | 3 |
| Required | false |
| Default Value | asc |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-TenantName <String>
The name of the Nectar DXP tenant. Used in multi-tenant configurations.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 4 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-PageSize <Int32>
The size of the page used to return data. Defaults to 1000
| Parameter | Value |
|---|---|
| Required | false |
| Position | 5 |
| Required | false |
| Default Value | 1000 |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-ResultSize <Int32>
The total number of results to return. Defaults to 100000. Maximum result size is 9,999,999 results
| Parameter | Value |
|---|---|
| Required | false |
| Position | 6 |
| Required | false |
| Default Value | 100000 |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Was this article helpful?