Zephyr: Get Environments
zephyr_get_environmentsRetrieve Zephyr test environments, filtered by Jira project key, with pagination to control result size and starting position.
Instructions
Get environments in Zephyr
Toolset: Environment
Parameters:
projectKey (string): Jira project key filter
maxResults (number): Specifies the maximum number of results to return in a single call. The default value is 10, and the maximum value that can be requested is 1000.
Note that the server may enforce a lower limit than requested, depending on resource availability or other internal constraints. If this happens, the result set may be truncated. Always check the maxResults value in the response to confirm how many results were actually returned. (default: 10)
startAt (number): Zero-indexed starting position. Should be a multiple of maxResults. (default: 0)
Examples:
Get the first 20 Environments
{
"maxResults": 20,
"startAt": 0
}Expected Output: The first 20 Environments with their details from different projects
Get the first 10 Environments from the project with projectKey TEST
{
"projectKey": "TEST",
"maxResults": 10,
"startAt": 0
}Expected Output: The first 10 Environments with their details from project with projectKey TEST
Get second 10 Environments from the project with projectKey TEST
{
"projectKey": "TEST",
"maxResults": 10,
"startAt": 10
}Expected Output: The second 10 Environments with their details from project with projectKey TEST
Get Environments starting from the 5th Environment from different projects
{
"startAt": 5,
"maxResults": 10
}Expected Output: Environments starting from the 5th one with their details from different projects
Get 5 Environments starting from the 10th Environment from the project with projectKey PROJ
{
"startAt": 10,
"maxResults": 5,
"projectKey": "PROJ"
}Expected Output: The five environments starting from the 10th Environment from the project PROJ with their details
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| startAt | No | Zero-indexed starting position. Should be a multiple of maxResults. | |
| maxResults | No | Specifies the maximum number of results to return in a single call. The default value is 10, and the maximum value that can be requested is 1000. Note that the server may enforce a lower limit than requested, depending on resource availability or other internal constraints. If this happens, the result set may be truncated. Always check the maxResults value in the response to confirm how many results were actually returned. | |
| projectKey | No | Jira project key filter |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| next | No | URL to the next page of results, or null if there are no more results. | |
| total | No | Indicates the total number of items available across all pages. | |
| isLast | No | Indicates if this is the last page of results. | |
| values | No | ||
| startAt | Yes | Indicates the index of the first item returned in the page of results. | |
| maxResults | Yes | Indicates the maximum number of results in this response. Note that the server may enforce a lower limit than requested, depending on resource availability or other internal constraints. |